autogen/README.md

60 lines
856 B
Markdown
Raw Normal View History

# AutoGenNext
2024-05-08 06:12:56 +08:00
2024-05-17 23:09:59 +08:00
## Package layering
- `core` are the the foundational generic interfaces upon which all else is built. This module must not depend on any other module.
2024-06-04 22:00:05 +08:00
- `components` are the building blocks for creating single agents
- `application` are implementations of core components that are used to compose an application
2024-05-23 01:25:51 +08:00
- `chat` is the concrete implementation of multi-agent interactions. Most users will deal with this module.
2024-05-17 23:09:59 +08:00
## Development
2024-05-08 06:12:56 +08:00
### Setup
2024-05-08 06:12:56 +08:00
```sh
python -m venv .venv
source .venv/bin/activate
2024-05-08 06:12:56 +08:00
pip install -e ".[dev]"
```
2024-05-08 06:12:56 +08:00
### Running tests
2024-05-08 06:12:56 +08:00
```sh
pytest
```
2024-05-08 06:12:56 +08:00
### Type checking
2024-05-08 06:12:56 +08:00
```sh
mypy
```
2024-05-08 06:12:56 +08:00
```sh
pyright
```
### Linting
```sh
ruff check
```
### Formatting
```sh
ruff format
```
### Build docs
```sh
pip install -e ".[docs]"
sphinx-build docs/src docs/build
# To view the docs:
python -m http.server -d docs/build
```