Skip to main content

Postgres-based distributed task processing library

Project description

Procrastinate: PostgreSQL-based Task Queue for Python

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

Procrastinate is looking for additional maintainers!

Procrastinate is an open-source Python 3.10+ distributed task processing library, leveraging PostgreSQL 13+ to store task definitions, manage locks and dispatch tasks. It can be used within both sync and async code, has Django integration, and is easy to use with ASGI frameworks. It supports periodic tasks, retries, arbitrary task locks etc.

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 (if you want to run the code yourself, head to Quickstart):

# mycode.py
import procrastinate

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

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

with app.open():
    # Launch a job
    sum.defer(a=3, b=5)

# Somewhere in your program, run a worker (actually, it's usually a
# different program than the one deferring jobs for execution)
app.run_worker(queues=["sums"])

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 -q sums

Lastly, you can use Procrastinate asynchronously too (actually, it's the recommended way to use it):

import asyncio

import procrastinate

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

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

async with app.open_async():
    # Launch a job
    await sum.defer_async(a=3, b=5)

    # Somewhere in your program, run a worker (actually, it's often a
    # different program than the one deferring jobs for execution)
    await app.run_worker_async(queues=["sums"])

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.

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.

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

procrastinate-3.7.2.tar.gz (83.9 kB view details)

Uploaded Source

Built Distribution

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

procrastinate-3.7.2-py3-none-any.whl (147.7 kB view details)

Uploaded Python 3

File details

Details for the file procrastinate-3.7.2.tar.gz.

File metadata

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

File hashes

Hashes for procrastinate-3.7.2.tar.gz
Algorithm Hash digest
SHA256 9845f6aa464b525fd0f38934f56bc4c04f4631bbdcb23fedc8c656c006e89d79
MD5 b3a6e631d2f09f2a5a234c0cfd5bcefa
BLAKE2b-256 aeb4e4940db96fed26c50bb58bc184f060fd8025388a37dec384ac2f16887eae

See more details on using hashes here.

Provenance

The following attestation bundles were made for procrastinate-3.7.2.tar.gz:

Publisher: ci.yml on procrastinate-org/procrastinate

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

File details

Details for the file procrastinate-3.7.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for procrastinate-3.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a2c71eb592067c57ec19d1a5074c81d4859489d2f8036ec3c2c046edf175736f
MD5 55951dc6fbfa60282ff82262d65e0499
BLAKE2b-256 4aa3e07797a7aaf36892ea506c4520e7b605f25fb8ae0d7e7eb5ab1f22a55b51

See more details on using hashes here.

Provenance

The following attestation bundles were made for procrastinate-3.7.2-py3-none-any.whl:

Publisher: ci.yml on procrastinate-org/procrastinate

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