Back to packageRELEASE DETAILS

0.0.0

PyPI

aagent

Actors and Agents combined.

Published30 Nov 2023

Direct dependencies8

Transitive dependenciesNot calculated

README

Version 0.0.0 documentation

aagent

Actors and Agents combined.

Using

Python package: to add and install this package as a dependency of your project, run poetry add aagent.

Python CLI: to view this app's CLI commands once it's installed, run aagent --help.

Python application: to serve this REST API, run docker compose up app and open localhost:8000 in your browser. Within the Dev Container, this is equivalent to running poe api.

Contributing

Prerequisites

1. Set up Git to use SSH

Generate an SSH key and add the SSH key to your GitHub account.

Configure SSH to automatically load your SSH keys:

cat << EOF >> ~/.ssh/config
Host *
  AddKeysToAgent yes
  IgnoreUnknown UseKeychain
  UseKeychain yes
EOF

2. Install Docker

Install Docker Desktop.
- Enable Use Docker Compose V2 in Docker Desktop's preferences window.
- Linux only:
  - Configure Docker to use the BuildKit build system. On macOS and Windows, BuildKit is enabled by default in Docker Desktop.
  - Export your user's user id and group id so that files created in the Dev Container are owned by your user:
```
cat << EOF >> ~/.bashrc
export UID=$(id --user)
export GID=$(id --group)
EOF
```

3. Install VS Code or PyCharm

Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.
Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or configure PyCharm to use it.

Development environments

The following development environments are supported:

⭐️ GitHub Codespaces: click on Code and select Create codespace to start a Dev Container with GitHub Codespaces.
⭐️ Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.
Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.
PyCharm: clone this repository, open it with PyCharm, and configure Docker Compose as a remote interpreter with the dev service.
Terminal: clone this repository, open it with your terminal, and run docker compose up --detach dev to start a Dev Container in the background, and then run docker compose exec dev zsh to open a shell prompt in the Dev Container.

Developing

Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
Run poetry add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and poetry.lock. Add --group test or --group dev to install a CI or development dependency, respectively.
Run poetry update from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 8

Native requirements

8 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
coloredlogs Environment { "extras": "", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`coloredlogs (>=15.0.1)`	runtime
fastapi Environment { "extras": "all", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`fastapi[all] (>=0.92.0)`	runtime
gunicorn Environment { "extras": "", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`gunicorn (>=20.1.0)`	runtime
poethepoet Environment { "extras": "", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`poethepoet (>=0.20.0)`	runtime
pydantic Environment { "extras": "", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`pydantic (>=1.10.7)`	runtime
streamlit Environment { "extras": "", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`streamlit (>=1.19.0)`	runtime
typer Environment { "extras": "all", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`typer[all] (>=0.9.0)`	runtime
uvicorn Environment { "extras": "standard", "marker": null, "requires_python": ">=3.11,<4.0", "evaluation": "NOT_EVALUATED" }	`uvicorn[standard] (>=0.20.0)`	runtime