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:
        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.12 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.

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.9.2.tar.gz (140.6 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.9.2-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pydocket-0.9.2.tar.gz
Algorithm Hash digest
SHA256 5d9eb5a3a3b30a435a5df3f87dadca4444433f973dcdc7fa008f6657074d332f
MD5 5607712cc844ee1a5720173127210bb3
BLAKE2b-256 c870c6cea453afec3f9039f3aca3999befac08ae6c0a4188fa9a5bdbcdb0d88f

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for pydocket-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dbf5c27784ee7ac22ea578240c454cddcde219bada728afd8bcd415820d60824
MD5 3a62ebaee873ff1ca3e12a214f07c494
BLAKE2b-256 626bfed4c34580ce69651afd1210fa8b770f95156c715774f29dd40dba9a0f65

See more details on using hashes here.

Provenance

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