diff --git a/python/README.md b/python/README.md index fbe558421..5b012ff60 100644 --- a/python/README.md +++ b/python/README.md @@ -8,28 +8,29 @@ See [`autogen-core`](./packages/autogen-core/) package for main functionality. **TL;DR**, run all checks with: ```sh -uv sync --all-extras +uv sync --all-extras source .venv/bin/activate poe check ``` ### Setup - +`uv` is a package manager that assists in creating the necessary environment and installing packages to run AutoGen. - [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: +### Virtual Environment +During development, you may need to test changes made to any of the packages.\ +To do so, create a virtual environment where the AutoGen packages are installed based on the current state of the directory.\ +Run the following commands at the root level of the Python directory: ```sh -uv sync --all-extras +uv sync --all-extras source .venv/bin/activate ``` +- `uv sync --all-extras` will create a `.venv` directory at the current level and install packages from the current directory along with any other dependencies. The `all-extras` flag adds optional dependencies. +- `source .venv/bin/activate` activates the virtual environment. -### Common tasks - +### Common Tasks +To create a pull request (PR), ensure the following checks are met. You can run each check individually: - Format: `poe format` - Lint: `poe lint` - Test: `poe test` @@ -37,14 +38,15 @@ source .venv/bin/activate - Pyright: `poe pyright` - Build docs: `poe --directory ./packages/autogen-core/ docs-build` - Auto rebuild+serve docs: `poe --directory ./packages/autogen-core/ docs-serve` +Alternatively, you can run all the checks with: +- `poe check` > [!NOTE] > These need to be run in the virtual environment. +### Creating a New Package -### Create new package - -To create a new package, run: +To create a new package, similar to `autogen-core` or `autogen-chat`, use the following: ```sh uv sync diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/command-line-code-executors.ipynb b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/command-line-code-executors.ipynb index 62de20d95..244d258aa 100644 --- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/command-line-code-executors.ipynb +++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/command-line-code-executors.ipynb @@ -7,7 +7,7 @@ "# Command Line Code Executors\n", "\n", "Command line code execution is the simplest form of code execution.\n", - "Generally speaking, it will save each code block to a file and the execute that file.\n", + "Generally speaking, it will save each code block to a file and then execute that file.\n", "This means that each code block is executed in a new process. There are two forms of this executor:\n", "\n", "- Docker ({py:class}`~autogen_ext.code_executor.docker_executor.DockerCommandLineCodeExecutor`) - this is where all commands are executed in a Docker container\n", @@ -15,6 +15,11 @@ "\n", "## Docker\n", "\n", + "```{note}\n", + "To use `DockerCommandLineCodeExecutor`, ensure the `autogen-ext[docker]` package is installed. For more details, see the [Packages Documentation](https://microsoft.github.io/autogen/dev/packages/index.html).\n", + "\n", + "```\n", + "\n", "The {py:class}`~autogen_ext.code_executor.docker_executor.DockerCommandLineCodeExecutor` will create a Docker container and run all commands within that container. \n", "The default image that is used is `python:3-slim`, this can be customized by passing the `image` parameter to the constructor. \n", "If the image is not found locally then the class will try to pull it. \n",