https://github.com/chrisguidry/docket
docket is a distributed background task system for Python
https://github.com/chrisguidry/docket
python redis tasks
Last synced: about 2 months ago
JSON representation
docket is a distributed background task system for Python
- Host: GitHub
- URL: https://github.com/chrisguidry/docket
- Owner: chrisguidry
- License: other
- Created: 2025-02-25T23:02:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-21T22:16:20.000Z (5 months ago)
- Last Synced: 2026-01-22T07:10:06.508Z (5 months ago)
- Topics: python, redis, tasks
- Language: Python
- Homepage: https://chrisguidry.github.io/docket/
- Size: 942 KB
- Stars: 80
- Watchers: 3
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Docket is a distributed background task system for Python functions with a focus
on the scheduling of future work as seamlessly and efficiently as immediate work.
[](https://pypi.org/project/pydocket/)
[](https://pypi.org/project/pydocket/)
[](https://github.com/chrisguidry/docket/actions/workflows/ci.yml)
[](https://app.codecov.io/gh/chrisguidry/docket)
[](https://github.com/chrisguidry/docket/blob/main/LICENSE)
[](https://docket.lol/)
## At a glance
```python
from datetime import datetime, timedelta, timezone
from docket import Docket
async def greet(name: str, greeting="Hello") -> None:
print(f"{greeting}, {name} at {datetime.now()}!")
async with Docket() as docket:
await docket.add(greet)("Jane")
now = datetime.now(timezone.utc)
soon = now + timedelta(seconds=3)
await docket.add(greet, when=soon)("John", greeting="Howdy")
```
```python
from docket import Docket, Worker
async with Docket() as docket:
async with Worker(docket) as worker:
worker.register(greet)
await worker.run_until_finished()
```
```
Hello, Jane at 2025-03-05 13:58:21.552644!
Howdy, John at 2025-03-05 13:58:24.550773!
```
Check out our docs for more [details](https://docket.lol/),
[examples](https://docket.lol/en/latest/getting-started/), and the [API
reference](https://docket.lol/en/latest/api-reference/).
## Why `docket`?
⚡️ Snappy one-way background task processing without any bloat
📅 Schedule immediate or future work seamlessly with the same interface
⏭️ Skip problematic tasks or parameters without redeploying
🌊 Purpose-built for Redis streams
🧩 Fully type-complete and type-aware for your background task functions
💉 Dependency injection like FastAPI, Typer, and FastMCP for reusable resources
## Installing `docket`
Docket is [available on PyPI](https://pypi.org/project/pydocket/) under the package name
`pydocket`. It targets Python 3.10 or above.
With [`uv`](https://docs.astral.sh/uv/):
```bash
uv pip install pydocket
or
uv add pydocket
```
With `pip`:
```bash
pip install pydocket
```
Docket requires a [Redis](http://redis.io/) server with Streams support (which was
introduced in Redis 5.0.0). Docket is tested with:
- Redis 6.2, 7.4, and 8.6 (standalone and cluster modes)
- [Valkey](https://valkey.io/) 8.1
- In-memory backend via [burner-redis](https://github.com/PrefectHQ/burner-redis) for testing
For testing without Redis, use the in-memory backend:
```python
from docket import Docket
async with Docket(name="my-docket", url="memory://my-docket") as docket:
# Use docket normally - all operations are in-memory
...
```
See [Testing with Docket](https://docket.lol/en/latest/testing/#using-in-memory-backend-no-redis-required) for more details.
# Hacking on `docket`
We use [`uv`](https://docs.astral.sh/uv/) for project management, so getting set up
should be as simple as cloning the repo and running:
```bash
uv sync
```
The to run the test suite:
```bash
pytest
```
We aim to maintain 100% test coverage, which is required for all PRs to `docket`. We
believe that `docket` should stay small, simple, understandable, and reliable, and that
begins with testing all the dusty branches and corners. This will give us the
confidence to upgrade dependencies quickly and to adapt to new versions of Redis over
time.
To work on the documentation locally:
```bash
uv sync
uv run zensical serve
```
This will start a local preview server. The docs are built with
[Zensical](https://zensical.org/) and configured in `mkdocs.yml`.