From 68cc2e101919dbb35e78e99dd328c97c74decaaf Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Tue, 4 Feb 2025 11:35:51 -0800 Subject: [PATCH] docs(python): add instructions for syncing dependencies and checking samples (#5362) Address some common questions. --- python/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/python/README.md b/python/README.md index 4c8b53fda..91f5dd9dc 100644 --- a/python/README.md +++ b/python/README.md @@ -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: