mirror of
https://github.com/microsoft/autogen.git
synced 2025-11-27 15:38:48 +00:00
* add standard contributing.md Fill out contributing guide on website #455 * add contibuting.md #455 * Update CONTRIBUTING.md Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gagb <gagb@users.noreply.github.com> * add symlink to top level contributing --------- Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com> Co-authored-by: gagb <gagb@users.noreply.github.com>
AutoGen Python packages
See autogen-core package for main functionality.
Development
TL;DR, run all checks with:
uv sync
source .venv/bin/activate
poe check
Setup
Virtual environment
To get a shell with the package available (virtual environment), in the current directory, run:
uv sync
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:
uv sync
source .venv/bin/activate
cookiecutter ./templates/new-package/