jangocheng/dapr-python-sdk

Dapr SDK for Python

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

Status

Note: Dapr SDK for python is currently under community development in alpha phase.

Getting started

Prerequisites

• Install Dapr standalone mode
• Install Python 3.7+

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-dev

# 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. Clone python-sdk

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

2. Install a project in a editable mode

pip3 install -e .
pip3 install -e ./ext/dapr-ext-grpc/
pip3 install -e ./ext/dapr-ext-fastapi/

3. Install required packages

pip3 install -r dev-requirements.txt

4. Run linter

tox -e flake8

5. Run unit-test

tox -e py37

6. Run type check

tox -e type

7. Run examples

tox -e examples

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:

tox -e doc

The generated files will be found in docs/_build.

Generate gRPC Protobuf client

pip3 install -r dev-requirements.txt

./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.