uses:Swatinem/rust-cache@v2

with:

workspaces:temporalio/bridge -> target

-run:python -m pip install --upgrade wheel "poetry==1.3.2" poethepoet

-run:poetry install --no-root --all-extras

-uses:astral-sh/setup-uv@v5

-run:uv sync --all-extras

-if:${{ matrix.package-suffix == 'linux-amd64' }}

run:poetry build --formatsdist

run:uv build --sdist

-run:poetry run cibuildwheel --output-dir dist

-run:poe fix-wheel

-run:uv run cibuildwheel --output-dir dist

-run:poe test-dist-single

-name:Test wheel

shell:bash

run:|

-uses:actions/upload-artifact@v4

version:"23.x"

repo-token:${{ secrets.GITHUB_TOKEN }}

-run:python -m pip install --upgrade wheel poetry poethepoet

-run:poetry install --no-root --all-extras

-uses:astral-sh/setup-uv@v5

-run:uv tool install poethepoet

-run:uv sync --all-extras

-run:poe bridge-lint

if:${{ matrix.clippyLinter }}

-run:poe lint

env:

TEMPORAL_TEST_PROTO3:1

run:|

features-tests:

uses:temporalio/features/.github/workflows/python.yaml@main

uses:temporalio/features/.github/workflows/python.yaml@uv

with:

python-repo-path:${{github.event.pull_request.head.repo.full_name}}

version:${{github.event.pull_request.head.ref}}

version-is-repo-ref:true

features-repo-ref:uv

version:"23.x"

repo-token:${{ secrets.GITHUB_TOKEN }}

-uses:astral-sh/setup-uv@v5

-run:python -m pipinstall --upgrade wheel poetry poethepoet

-run:poetry install --no-root --all-extras

-run:uv toolinstall poethepoet

-run:uv sync --all-extras

-run:poe build-develop-with-release

To build the SDK from source for use as a dependency, the following prerequisites are required:

*[Python](https://www.python.org/) >= 3.9

* Make sure the latest version of`pip` is in use

*[uv](https://docs.astral.sh/uv/)

*[Rust](https://www.rust-lang.org/)

*[Protobuf Compiler](https://protobuf.dev/)

*[poetry](https://github.com/python-poetry/poetry) (e.g.`python -m pip install poetry`)

*[poe](https://github.com/nat-n/poethepoet) (e.g.`python -m pip install poethepoet`)

macOS note: If errors are encountered, it may be better to install Python and Rust as recommended from their websites

instead of via`brew`.

Use`uv` to install`poe`:

With the prerequisites installed, first clone the SDK repository recursively:

uv tool install poethepoet

Now clone the SDK repository recursively:

git clone --recursive https://github.com/temporalio/sdk-python.git

cd sdk-python

Use`poetry` to install the dependencies with`--no-root` to not install this package (because we still need to build

it):

Install the dependencies:

poetry install --no-root --all-extras

uv sync --all-extras

environment](#local-sdk-development-environment) for the quicker approach to local development).

poetry build

uv build

The compiled wheel doesn't have the exact right tags yet for use, so run this script to fix it:

poe fix-wheel

The`whl` wheel file in`dist/` is now ready to use.

The`.whl` wheel file in`dist/` is now ready to use.

For local development, it is often quicker to use debug builds and a local virtual environment.

While not required, it often helps IDEs if we put the virtual environment`.venv` directory in the project itself. This

can be configured system-wide via:

poetry config virtualenvs.in-projecttrue

For local development, it is quicker to use a debug build.

Now performthe same steps as the "Prepare" section above by installing the prerequisites, cloning the project,

installing dependencies, and generating the protobuf code:

Performthe same steps as the "Prepare" section above by installing the prerequisites, cloning the project, and

installing dependencies:

git clone --recursive https://github.com/temporalio/sdk-python.git

cd sdk-python

poetry install --no-root --all-extras

uv sync --all-extras

Now compile the Rust extension in develop mode which is quicker than release mode:

To allow for backwards compatibility, protobuf code is generated on the 3.x series of the protobuf library. To generate

protobuf code, you must be on Python <= 3.10, and then run`poetry add "protobuf<4"` +

`poetry install --no-root --all-extras`. Then theprotobuf files can be generated via`poe gen-protos`. Tests can be run

for protobuf version 3 by setting the`TEMPORAL_TEST_PROTO3` env var to`1` prior to running tests.

protobuf code, you must be on Python <= 3.10, and then run`uv add "protobuf<4"` +`uv sync --all-extras`. Then the

protobuf files can be generated via`poe gen-protos`. Tests can be run for protobuf version 3 by setting the

`TEMPORAL_TEST_PROTO3` env var to`1` prior to running tests.

Do not commit`poetry.lock` or`pyproject.toml` changes. To go back from this downgrade, restore both of those files

and run`poetry install --no-root --all-extras`. Make sure you`poe format` the results.

Do not commit`uv.lock` or`pyproject.toml` changes. To go back from this downgrade, restore both of those files and run

`uv sync --all-extras`. Make sure you`poe format` the results.

For a less system-intrusive approach, you can (note this approach[may have a bug](https://github.com/temporalio/sdk-python/issues/543)):

For a less system-intrusive approach, you can:

docker build -f scripts/_proto/Dockerfile.

docker run --rm -v"${PWD}/temporalio/api:/api_new" -v"${PWD}/temporalio/bridge/proto:/bridge_new"<just built image sha>

* Mostly[Google Style Guide](https://google.github.io/styleguide/pyguide.html). Notable exceptions:

* We use[Black](https://github.com/psf/black) for formatting, so that takes precedence

* We use[ruff](https://docs.astral.sh/ruff/) for formatting, so that takes precedence

* In tests and example code, can import individual classes/functions to make it more readable. Can also do this for

rarely in library code for some Python common items (e.g.`dataclass` or`partial`), but not allowed to do this for

any`temporalio` packages (except`temporalio.types`) or any classes/functions that aren't clear when unqualified.