Skip to main content

Postgres-based distributed task processing library

Project description

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
import procrastinate

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

# 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 often 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:

import asyncio

import procrastinate

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

# 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.

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 namedProcrastinate”.

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-0.21.0.tar.gz (55.2 kB view details)

Uploaded Source

Built Distribution

procrastinate-0.21.0-py3-none-any.whl (77.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: procrastinate-0.21.0.tar.gz
  • Upload date:
  • Size: 55.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.8.10 Linux/5.8.0-1041-azure

File hashes

Hashes for procrastinate-0.21.0.tar.gz
Algorithm Hash digest
SHA256 2b039037fa8414af63cb91b70e7103808ba536e40e72e3120915fe3b97bd089e
MD5 7ab1b7b8cc7fb174016387e8b4ddc4d7
BLAKE2b-256 29d6d02c8229018f174a7040eb7f440158f43c1b99200e8f71eb90f05a0eff7c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: procrastinate-0.21.0-py3-none-any.whl
  • Upload date:
  • Size: 77.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.8.10 Linux/5.8.0-1041-azure

File hashes

Hashes for procrastinate-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8580490bf955f7e6b7c9410aa8c3b2a4ba8e47dcaa4f3c944b9204803e7e2ee1
MD5 5e5a386a10ad91e98a0b00d576d802fb
BLAKE2b-256 b13d5e3ce1246fd989d34cb07d0623f07247eb7b22ca0969d3ecacdc78401cfa

See more details on using hashes here.

Supported by

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