yujunjun/autogen
1
0
Fork 0
mirror of https://github.com/microsoft/autogen.git synced 2025-11-11 15:24:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(python): add instructions for syncing dependencies and checking samples (#5362)

Browse Source 
Address some common questions.
This commit is contained in:
Eric Zhu 2025-02-04 11:35:51 -08:00 committed by GitHub
parent 40d74a32a1
commit 68cc2e1019
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
python/README.md
View File

@ -50,12 +50,24 @@ To create a pull request (PR), ensure the following checks are met. You can run
- Pyright: `poe pyright` - Pyright: `poe pyright`
- Build docs: `poe --directory ./packages/autogen-core/ docs-build` - Build docs: `poe --directory ./packages/autogen-core/ docs-build`
- Auto rebuild+serve docs: `poe --directory ./packages/autogen-core/ docs-serve` - Auto rebuild+serve docs: `poe --directory ./packages/autogen-core/ docs-serve`
- Check samples in `python/samples`: `poe samples-code-check`
Alternatively, you can run all the checks with: Alternatively, you can run all the checks with:
- `poe check` - `poe check`
> [!NOTE] > [!NOTE]
> These need to be run in the virtual environment. > These need to be run in the virtual environment.
### Syncing Dependencies
When you pull new changes, you may need to update the dependencies.
To do so, first make sure you are in the virtual environment, and then in the `python` directory, run:
```sh
uv sync --all-extras
```
This will update the dependencies in the virtual environment.
### Creating a New Package ### Creating a New Package
To create a new package, similar to `autogen-core` or `autogen-chat`, use the following: To create a new package, similar to `autogen-core` or `autogen-chat`, use the following: