pydocket0.13.1
Published
A distributed background task system for Python functions
pip install pydocket
Package Downloads
Authors
Project URLs
Requires Python
>=3.10
Dependencies
- cloudpickle
>=3.1.1 - exceptiongroup
>=1.2.0; python_version < "3.11" - fakeredis
[lua]>=2.32.1 - opentelemetry-api
>=1.30.0 - opentelemetry-exporter-prometheus
>=0.51b0 - prometheus-client
>=0.21.1 - py-key-value-aio
[memory,redis]>=0.2.8 - python-json-logger
>=3.2.1 - redis
>=5 - rich
>=13.9.4 - typer
>=0.15.1 - typing-extensions
>=4.12.0 - uuid7
>=0.1.0
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.
At a glance
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")
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, examples, and the 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 under the package name
pydocket. It targets Python 3.10 or above.
With uv:
uv pip install pydocket
or
uv add pydocket
With pip:
pip install pydocket
Docket requires a Redis server with Streams support (which was introduced in Redis 5.0.0). Docket is tested with Redis 6 and 7.
For testing without Redis, Docket includes fakeredis for in-memory operation:
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 for more details.
Hacking on docket
We use uv for project management, so getting set up
should be as simple as cloning the repo and running:
uv sync
The to run the test suite:
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.