Skip to main content

A distributed background task system for Python functions

Project description

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.

PyPI - Version PyPI - Python Version GitHub main checks Codecov PyPI - License Documentation

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.2, 7.4, and 8.0 (standalone and cluster modes)
  • Valkey 8.0
  • In-memory backend via fakeredis for testing

For testing without Redis, use the in-memory backend:

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydocket-0.17.3.tar.gz (329.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydocket-0.17.3-py3-none-any.whl (91.6 kB view details)

Uploaded Python 3

File details

Details for the file pydocket-0.17.3.tar.gz.

File metadata

  • Download URL: pydocket-0.17.3.tar.gz
  • Upload date:
  • Size: 329.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pydocket-0.17.3.tar.gz
Algorithm Hash digest
SHA256 8922b4ca5f3f428e69b7695b9b5a313bbedc3ce35c74045cadcd89f7c0e6ac2d
MD5 df9983d25b6bb9b50105d66499188f07
BLAKE2b-256 ec65eb3b4f7afac80308d74bab2a668b31f074524ff6fbc664a685c6ed7c8885

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydocket-0.17.3.tar.gz:

Publisher: publish.yml on chrisguidry/docket

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydocket-0.17.3-py3-none-any.whl.

File metadata

  • Download URL: pydocket-0.17.3-py3-none-any.whl
  • Upload date:
  • Size: 91.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pydocket-0.17.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9ef2c6e855f52a3210acff300bcbcc45773d79295e2deddcc7aef7f67b2a5ba7
MD5 528bd571e680994cc0b5726fe18329e7
BLAKE2b-256 ea3b29c69e4f88f5e5ea5e90e3cf93493cafb68bf9a2f625b916cc26ab1def89

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydocket-0.17.3-py3-none-any.whl:

Publisher: publish.yml on chrisguidry/docket

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page