mirror of
https://github.com/microsoft/autogen.git
synced 2025-09-07 23:36:04 +00:00
53e5951474
* migrate code executor and tests * update extras * update dependencies and examples * fix imports * fix uv lock * add code_executor to toctree --------- Co-authored-by: Leonardo Pinheiro <lpinheiro@microsoft.com> Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
54 lines
967 B
Markdown
54 lines
967 B
Markdown
# AutoGen Python packages
|
|
|
|
See [`autogen-core`](./packages/autogen-core/) package for main functionality.
|
|
|
|
|
|
## Development
|
|
|
|
**TL;DR**, run all checks with:
|
|
|
|
```sh
|
|
uv sync --all-extras
|
|
source .venv/bin/activate
|
|
poe check
|
|
```
|
|
|
|
### Setup
|
|
|
|
- [Install `uv`](https://docs.astral.sh/uv/getting-started/installation/).
|
|
|
|
### Virtual environment
|
|
|
|
To get a shell with the package available (virtual environment),
|
|
in the current directory,
|
|
run:
|
|
|
|
```sh
|
|
uv sync --all-extras
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
### Common tasks
|
|
|
|
- Format: `poe format`
|
|
- Lint: `poe lint`
|
|
- Test: `poe test`
|
|
- Mypy: `poe mypy`
|
|
- Pyright: `poe pyright`
|
|
- Build docs: `poe --directory ./packages/autogen-core/ docs-build`
|
|
- Auto rebuild+serve docs: `poe --directory ./packages/autogen-core/ docs-serve`
|
|
|
|
> [!NOTE]
|
|
> These need to be run in the virtual environment.
|
|
|
|
|
|
### Create new package
|
|
|
|
To create a new package, run:
|
|
|
|
```sh
|
|
uv sync
|
|
source .venv/bin/activate
|
|
cookiecutter ./templates/new-package/
|
|
```
|