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 looking for additional maintainers!

Procrastinate is an open-source Python 3.8+ 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 and integrated to Django.

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

Uploaded Source

Built Distribution

procrastinate-1.0.1-py3-none-any.whl (90.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: procrastinate-1.0.1.tar.gz
  • Upload date:
  • Size: 64.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for procrastinate-1.0.1.tar.gz
Algorithm Hash digest
SHA256 70d24eeef9980a61809cc432f43916230462cc2aae23e920e7ed2bf98c567f60
MD5 d4badd44d13085e2d90f9fd830528f09
BLAKE2b-256 233ac5e3658543f55f361eae2d492e3869b82c974b3102e3ef23139621fe8408

See more details on using hashes here.

File details

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

File metadata

  • Download URL: procrastinate-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 90.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for procrastinate-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08e8613617ee437b9ecfebb3855c1d7c97ffcaae17c2131f9087a723970b6812
MD5 335bc1c3176aac61a9391e4c5cb49143
BLAKE2b-256 dd2fb48212f60817b511f5d0cacb394f6a89d56bbd7d5507d689b53830ef426a

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