Skip to content

Commit

Permalink
docs(python): add instructions for syncing dependencies and checking …
Browse files Browse the repository at this point in the history
…samples (#5362)

Address some common questions.
  • Loading branch information
ekzhu authored Feb 4, 2025
1 parent 40d74a3 commit 68cc2e1
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,24 @@ To create a pull request (PR), ensure the following checks are met. You can run
- Pyright: `poe pyright`
- Build docs: `poe --directory ./packages/autogen-core/ docs-build`
- 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:
- `poe check`

> [!NOTE]
> 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

To create a new package, similar to `autogen-core` or `autogen-chat`, use the following:
Expand Down

0 comments on commit 68cc2e1

Please sign in to comment.