Skip to content

Commit d0f9818

Browse files
Merge pull request #173 from dispatchrun/README-update-project-description
2 parents a41cfa2 + 155e0aa commit d0f9818

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

README.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[![PyPI version](https://badge.fury.io/py/dispatch-py.svg)](https://badge.fury.io/py/dispatch-py)
1414
[![Reference](https://img.shields.io/badge/API-Reference-lightblue.svg)](https://python.dispatch.run/main/reference/dispatch/)
1515

16-
Python package to develop applications with the Dispatch platform.
16+
Python package to develop applications with Dispatch.
1717

1818
[fastapi]: https://fastapi.tiangolo.com/tutorial/first-steps/
1919
[pypi]: https://pypi.org/project/dispatch-py/
@@ -36,7 +36,19 @@ Python package to develop applications with the Dispatch platform.
3636

3737
## What is Dispatch?
3838

39-
Dispatch is a platform for developing scalable & reliable distributed systems.
39+
Dispatch is a cloud service for developing scalable and reliable applications in
40+
Python, including:
41+
42+
- **Event-Driven Architectures**
43+
- **Background Jobs**
44+
- **Transactional Workflows**
45+
- **Multi-Tenant Data Pipelines**
46+
47+
Dispatch differs from alternative solutions by allowing developers to write
48+
simple Python code: it has a **minimal API footprint**, which usually only
49+
requires using a function decorator (no complex framework to learn), failure
50+
recovery is built-in by default for transient errors like rate limits or
51+
timeouts, with a **zero-configuration** model.
4052

4153
To get started, follow the instructions to [sign up for Dispatch][signup] 🚀.
4254

@@ -63,12 +75,19 @@ configuration, so we recommend starting with it._
6375

6476
### Installing the Dispatch SDK
6577

78+
> :warning: The Dispatch SDK requires **Python 3.8** or higher.
79+
6680
The Python package is published on [PyPI][pypi] as **dispatch-py**, to install:
6781

6882
```console
6983
pip install dispatch-py
7084
```
7185

86+
> :bulb: The Python SDK has integrations with **FastAPI**, **Flask**,
87+
> or the standard `http.server` package.
88+
>
89+
> For requests to integrate other frameworks, open an issue on [GitHub](https://github.com/dispatchrun/dispatch-py/issues/new
90+
7291
## Usage
7392

7493
### Writing Dispatch Applications

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "dispatch-py"
7-
description = "Develop reliable distributed systems on the Dispatch platform."
7+
description = "Develop reliable distributed systems with Dispatch."
88
readme = "README.md"
99
dynamic = ["version"]
1010
requires-python = ">= 3.8"

0 commit comments

Comments
 (0)