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, 7, and 8.

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.

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.16.1.tar.gz (289.0 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.16.1-py3-none-any.whl (63.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pydocket-0.16.1.tar.gz
Algorithm Hash digest
SHA256 8663cb6dc801d8b8d703541fb665f4099c84f4d10d8f3fd441e208b080aa4826
MD5 cca0b613b3c6186d2baa109cb659a8b3
BLAKE2b-256 2bff87e931e4abc7efb1e8c16adaa55327452931e8c5f460f2ba089447673226

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydocket-0.16.1.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.16.1-py3-none-any.whl.

File metadata

  • Download URL: pydocket-0.16.1-py3-none-any.whl
  • Upload date:
  • Size: 63.2 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.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc6ccf7e91164761def854b4014101abf23c3cc2fb7d0fa2c4e07ea3bf6a1826
MD5 6f47b780e9fd0a1b7c1daf77a7ed51f0
BLAKE2b-256 adab0da7d0397112546309709f464bdf65de4e1697e3caba07556751fc4d8bcd

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydocket-0.16.1-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