Skip to content

Commit a88594e

Browse files
committed
Update README.md
1 parent 62ec412 commit a88594e

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1-
# Project
1+
# Durable Task Client SDK for Python
22

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
54

6-
As the maintainer of this project, please make a few updates:
5+
This repo contains a Python client SDK for use with the [Durable Task Framework for Go](https://github.com/microsoft/durabletask-go) and [Dapr Workflow](https://docs.dapr.io/developing-applications/building-blocks/workflow/workflow-overview/). With this SDK, you can define, schedule, and manage durable orchestrations using ordinary Python code.
76

8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
7+
⚠️ **This SDK is currently under active development and is not yet ready for production use.** ⚠️
8+
9+
> Note that this project is **not** currently affiliated with the [Durable Functions](https://docs.microsoft.com/azure/azure-functions/durable/durable-functions-overview) project for Azure Functions. If you are looking for a Python SDK for Durable Functions, please see [this repo](https://github.com/Azure/azure-functions-durable-python).
10+
11+
## Getting Started
12+
13+
### Prerequisites
14+
15+
- Python 3.8 or higher
16+
17+
### Installing
18+
19+
#### Install from PyPI
20+
This package is not yet published to [PyPI](https://pypi.org/).
21+
22+
#### Install from source
23+
TODO
24+
25+
## Development
26+
The following is more information about how to develop this project.
1227

1328
### Generating protobufs
1429
If the gRPC proto definitions need to be updated, the corresponding source code can be regenerated using the following command from the project root:

0 commit comments

Comments
 (0)