Skip to main content

Procrastinate: PostgreSQL-based Task Queue for Python

Deployed to PyPI Deployed to PyPI GitHub Repository Continuous Integration Documentation Coverage MIT License Contributor Covenant

Procrastinate is an open-source Python 3.6+ distributed task processing library, leveraging PostgreSQL to store task definitions, manage locks and dispatch tasks. It can be used within both sync and async code.

In other words, from your main code, you call specific functions (tasks) in a special way and instead of being run on the spot, they’re scheduled to be run elsewhere, now or in the future.

Here’s an example

# mycode.py

# Make an app in your code
app = procrastinate.App(connector=procrastinate.AiopgConnector())

# Open the connection to the database
app.open()

# Then define tasks
@app.task(queue="sums")
def sum(a, b):
    with open("myfile", "w") as f:
        f.write(str(a + b))

# Launch a job
sum.defer(a=3, b=5)

# Somewhere in your program, run a worker
worker = procrastinate.Worker(
    app=app,
    queues=["sums"]
)
worker.run()

The worker will run the job, which will create a text file named myfile with the result of the sum 3 + 5 (that’s 8).

Similarly, from the command line:

export PROCRASTINATE_APP="mycode.app"

# Launch a job
procrastinate defer mycode.sum '{"a": 3, "b": 5}'

# Run a worker
procrastinate worker sums

Lastly, you can use Procrastinate asynchronously too:

# Define asynchronous tasks using coroutine functions
@app.task(queue="sums")
async def sum(a, b):
    await asyncio.sleep(a + b)

# Launch a job asynchronously
await sum.defer_async(a=3, b=5)

# Somewhere in your program, run a worker asynchronously
worker = procrastinate.Worker(
    app=app,
    queues=["sums"]
)
await worker.run_async()

There are quite a few interesting features that Procrastinate adds to the mix. You can head to the Quickstart section for a general tour or to the How-To sections for specific features. The Discussion section should hopefully answer your questions. Otherwise, feel free to open an issue.

The project is still quite early-stage and will probably evolve.

Note to my future self: add a quick note here on why this project is named “Procrastinate”.

Where to go from here

The complete docs is probably the best place to learn about the project.

If you encounter a bug, or want to get in touch, you’re always welcome to open a ticket.

Metadata

Release files for procrastinate 0.17.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for procrastinate 0.17.0
File Size Uploaded Provenance Actions
procrastinate-0.17.0.tar.gz 50.7 kB Without provenance Details for procrastinate-0.17.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for procrastinate 0.17.0
File Interpreter ABI Platform Actions
procrastinate-0.17.0-py3-none-any.whl Python 3 none any Details for procrastinate-0.17.0-py3-none-any.whl

Total release size: 113.6 kB

Release files / procrastinate-0.17.0.tar.gz

Download URL procrastinate-0.17.0.tar.gz
Size 50.7 kB
Tags Source
SHA-256 checksum
How to use checksums
dbe0aed0b43d419d09ac34d67b8e373b3532761c24cb6679d594eee72d47f338
BLAKE2b-256 checksum
How to use checksums
9d2f0a83f4f46058c4d5922d1ebcda0daeb46cc656dc7b05a2604595516ce79d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

Release files / procrastinate-0.17.0-py3-none-any.whl

Download URL procrastinate-0.17.0-py3-none-any.whl
Size 62.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
48416141b30abb0f3cd24c7fc79ac9ccc0a7526daee67e2f9578e8f1d3907cd8
BLAKE2b-256 checksum
How to use checksums
67d56035188cc59e8632e6ec5db1f239d3f853a75b5ac8d7cd0d9b77fbd99cf2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.5

Security for procrastinate 0.17.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.17.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page