Skip to content
Closed
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ coverage.xml
# Editor config
.idea
.vscode
.cursor

# Translations
*.mo
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@

[Dapr](https://docs.dapr.io/concepts/overview/) 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](https://docs.dapr.io/developing-applications/building-blocks/actors/actors-overview/), based on the actor design pattern. This SDK can run locally, in a container and in any distributed systems environment.
Dapr SDK for Python allows you to implement the [Virtual Actor model](https://docs.dapr.io/developing-applications/building-blocks/actors/actors-overview/), based on the actor design pattern. This SDK also provides conversation APIs for interacting with AI/LLM models through Dapr components, supporting both streaming and non-streaming responses, tool calling, and multi-turn conversations. This SDK can run locally, in a container and in any distributed systems environment.

This includes the following packages:

* [dapr.actor](./dapr/actor): Actor Framework
* [dapr.clients](./dapr/clients): Dapr clients for Dapr building blocks
* [dapr.clients](./dapr/clients): Dapr clients for Dapr building blocks and conversation APIs
* [dapr.conf](./dapr/conf): Configuration
* [dapr.serializers](./dapr/serializers): serializer/deserializer
* [dapr.proto](./dapr/proto): Dapr gRPC autogenerated gRPC clients
Expand Down Expand Up @@ -64,6 +64,7 @@ pip3 install dapr-ext-fastapi-dev

> Note: Do not install both packages.


### Try out examples

Go to [Examples](./examples)
Expand Down Expand Up @@ -124,6 +125,13 @@ tox -e type
tox -e examples
```

9. Test features in dapr not currently in upstream (requires local Dapr repository)

```bash
# Build and run development sidecar with conversation components
python tools/run_dapr_dev.py --build
```

## 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.
Expand All @@ -141,6 +149,9 @@ The generated files will be found in `docs/_build`.
```sh
pip3 install -r tools/requirements.txt
./tools/regen_grpcclient.sh

# For local development (uses ../dapr repository)
./tools/regen_grpcclient_local.sh
```

## Help & Feedback
Expand Down
Loading