dapr 1.17.0.dev0

The official release of Dapr Python SDK.

Dapr SDK for Python

Dapr is a portable, event-driven, serverless runtime for building distributed applications across cloud and edge.

Dapr SDK for Python allows you to implement the Virtual Actor model, based on the actor design pattern. This SDK can run locally, in a container and in any distributed systems environment.

This includes the following packages:

• dapr.actor: Actor Framework
• dapr.clients: Dapr clients for Dapr building blocks
• dapr.conf: Configuration
• dapr.serializers: serializer/deserializer
• dapr.proto: Dapr gRPC autogenerated gRPC clients
• dapr.ext.grpc: gRPC extension for Dapr
• dapr.ext.fastapi: FastAPI extension (actor) for Dapr
• flask.dapr: Flask extension (actor) for Dapr

Getting started

Prerequisites

• Install Dapr standalone mode
• Install Python 3.10+

Install Dapr python sdk

• Official package

# Install Dapr client sdk
pip3 install dapr

# Install Dapr gRPC AppCallback service extension
pip3 install dapr-ext-grpc

# Install Dapr Fast Api extension for Actor
pip3 install dapr-ext-fastapi

• Development package

# Install Dapr client sdk
pip3 install dapr

# Install Dapr gRPC AppCallback service extension
pip3 install dapr-ext-grpc-dev

# Install Dapr Fast Api extension for Actor
pip3 install dapr-ext-fastapi-dev

Note: Do not install both packages.

Try out examples

Go to Examples

Developing

Build and test

1. Install uv

2. Clone python-sdk

git clone https://github.com/dapr/python-sdk.git
cd python-sdk

3. Install all packages and dev dependencies

uv sync --all-packages --group dev

4. Run linter and autofix

uv run ruff check --fix && uv run ruff format

5. Run unit tests

uv run python -m unittest discover -v ./tests

6. Run type check

uv run mypy

7. Run integration tests

uv run pytest tests/integration/

8. Validate the examples

uv run pytest tests/examples/

If you need to run the examples or integration tests against a pre-released version of the runtime, you can use the following command:

• Get your daprd runtime binary from here for your platform.
• Copy the binary to your dapr home folder at $HOME/.dapr/bin/daprd. Or using dapr cli directly: dapr init --runtime-version <release version>
• Now you can run the examples with uv run pytest tests/examples/ or the integration tests with uv run pytest tests/integration/.

Documentation

Documentation is generated using Sphinx. Extensions used are mainly Napoleon (To process the Google Comment Style) and Autodocs (For automatically generating documentation). The .rst files are generated using Sphinx-Apidocs.

To generate documentation:

uv run --with sphinx sphinx-apidoc -E -o docs/actor dapr/actor
uv run --with sphinx sphinx-apidoc -E -o docs/clients dapr/clients
uv run --with sphinx sphinx-apidoc -E -o docs/proto dapr/proto
uv run --with sphinx sphinx-apidoc -E -o docs/serializers dapr/serializers
uv run --with sphinx make html -C docs

The generated files will be found in docs/_build.

Generate gRPC Protobuf client

uv sync --all-packages --group dev
export DAPR_BRANCH=release-1.17 # Optional, defaults to master
uv run ./tools/regen_grpcclient.sh

Help & Feedback

Need help or have feedback on the SDK? Please open a GitHub issue or come chat with us in the #python-sdk channel of our Discord server (click here to join).

Code of Conduct

This project follows the CNCF Code of Conduct.