celery
Distributed Task Queue.
Downloads: 0 (30 days)
Description
.. image:: https://docs.celeryq.dev/en/latest/_images/celery-banner-small.png
|build-status| |coverage| |license| |wheel| |semgrep| |pyversion| |pyimp| |ocbackerbadge| |ocsponsorbadge|
:Version: 5.6.2 (recovery)
:Web: https://docs.celeryq.dev/en/stable/index.html
:Download: https://pypi.org/project/celery/
:Source: https://github.com/celery/celery/
:DeepWiki: |deepwiki|
:Keywords: task, queue, job, async, rabbitmq, amqp, redis,
python, distributed, actors
Donations
=========
Open Collective
---------------
.. image:: https://opencollective.com/static/images/opencollectivelogo-footer-n.svg
:alt: Open Collective logo
:width: 200px
`Open Collective <https://opencollective.com/celery>`_ is our community-powered funding platform that fuels Celery's
ongoing development. Your sponsorship directly supports improvements, maintenance, and innovative features that keep
Celery robust and reliable.
For enterprise
==============
Available as part of the Tidelift Subscription.
The maintainers of ``celery`` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. `Learn more. <https://tidelift.com/subscription/pkg/pypi-celery?utm_source=pypi-celery&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_
Sponsors
========
Blacksmith
----------
.. image:: ./docs/images/blacksmith-logo-white-on-black.svg
:alt: Blacksmith logo
:width: 240px
:target: https://blacksmith.sh/
`Official Announcement <https://www.linkedin.com/pulse/celery-now-powered-blacksmith-tomer-nosrati-ew68e/?trackingId=DWHH49WqS2iOW8Jf5N1kEg%3D%3D>`_
CloudAMQP
---------
.. image:: ./docs/images/cloudamqp-logo-lightbg.svg
:alt: CloudAMQP logo
:width: 240px
:target: https://www.cloudamqp.com/
`CloudAMQP <https://www.cloudamqp.com/>`_ is a industry leading RabbitMQ as a service provider.
If you need highly available message queues, a perfect choice would be to use CloudAMQP.
With 24,000+ running instances, CloudAMQP is the leading hosting provider of RabbitMQ,
with customers all over the world.
Upstash
-------
.. image:: https://upstash.com/logo/upstash-dark-bg.svg
:alt: Upstash logo
:width: 200px
:target: https://upstash.com/?code=celery
`Upstash <http://upstash.com/?code=celery>`_ offers a serverless Redis database service,
providing a seamless solution for Celery users looking to leverage
serverless architectures. Upstash's serverless Redis service is designed
with an eventual consistency model and durable storage, facilitated
through a multi-tier storage architecture.
Dragonfly
---------
.. image:: https://github.com/celery/celery/raw/main/docs/images/dragonfly.svg
:alt: Dragonfly logo
:width: 150px
:target: https://www.dragonflydb.io/
`Dragonfly <https://www.dragonflydb.io/>`_ is a drop-in Redis replacement that cuts costs and boosts performance.
Designed to fully utilize the power of modern cloud hardware and deliver on the data demands of modern applications,
Dragonfly frees developers from the limits of traditional in-memory data stores.
.. |oc-sponsor-1| image:: https://opencollective.com/celery/sponsor/0/avatar.svg
:target: https://opencollective.com/celery/sponsor/0/website
What's a Task Queue?
====================
Task queues are used as a mechanism to distribute work across threads or
machines.
A task queue's input is a unit of work, called a task, dedicated worker
processes then constantly monitor the queue for new work to perform.
Celery communicates via messages, usually using a broker
to mediate between clients and workers. To initiate a task a client puts a
message on the queue, the broker then delivers the message to a worker.
A Celery system can consist of multiple workers and brokers, giving way
to high availability and horizontal scaling.
Celery is written in Python, but the protocol can be implemented in any
language. In addition to Python there's node-celery_ for Node.js,
a `PHP client`_, `gocelery`_, gopher-celery_ for Go, and rusty-celery_ for Rust.
Language interoperability can also be achieved by using webhooks
in such a way that the client enqueues an URL to be requested by a worker.
.. _node-celery: https://github.com/mher/node-celery
.. _`PHP client`: https://github.com/gjedeer/celery-php
.. _`gocelery`: https://github.com/gocelery/gocelery
.. _gopher-celery: https://github.com/marselester/gopher-celery
.. _rusty-celery: https://github.com/rusty-celery/rusty-celery
What do I need?
===============
Celery version 5.5.x runs on:
- Python (3.8, 3.9, 3.10, 3.11, 3.12, 3.13)
- PyPy3.9+ (v7.3.12+)
This is the version of celery which will support Python 3.8 or newer.
If you're running an older version of Python, you need to be running
an older version of Celery:
- Python 3.7: Celery 5.2 or earlier.
- Python 3.6: Celery 5.1 or earlier.
- Python 2.7: Celery 4.x series.
- Python 2.6: Celery series 3.1 or earlier.
- Python 2.5: Celery series 3.0 or earlier.
- Python 2.4: Celery series 2.2 or earlier.
Celery is a project with minimal funding,
so we don't support Microsoft Windows but it should be working.
Please don't open any issues related to that platform.
*Celery* is usually used with a message broker to send and receive messages.
The RabbitMQ, Redis transports are feature complete,
but there's also experimental support for a myriad of other solutions, including
using SQLite for local development.
*Celery* can run on a single machine, on multiple machines, or even
across datacenters.
Get Started
===========
If this is the first time you're trying to use Celery, or you're
new to Celery v5.5.x coming from previous versions then you should read our
getting started tutorials:
- `First steps with Celery`_
Tutorial teaching you the bare minimum needed to get started with Celery.
- `Next steps`_
A more complete overview, showing more features.
.. _`First steps with Celery`:
https://docs.celeryq.dev/en/stable/getting-started/first-steps-with-celery.html
.. _`Next steps`:
https://docs.celeryq.dev/en/stable/getting-started/next-steps.html
You can also get started with Celery by using a hosted broker transport CloudAMQP. The largest hosting provider of RabbitMQ is a proud sponsor of Celery.
Celery is...
=============
- **Simple**
Celery is easy to use and maintain, and does *not need configuration files*.
It has an active, friendly community you can talk to for support,
like at our `mailing-list`_, or the IRC channel.
Here's one of the simplest applications you can make:
.. code-block:: python
from celery import Celery
app = Celery('hello', broker='amqp://guest@localhost//')
@app.task
def hello():
return 'hello world'
- **Highly Available**
Workers and clients will automatically retry in the event
of connection loss or failure, and some brokers support
HA in way of *Primary/Primary* or *Primary/Replica* replication.
- **Fast**
A single Celery process can process millions of tasks a minute,
with sub-millisecond round-trip latency (using RabbitMQ,
py-librabbitmq, and optimized settings).
- **Flexible**
Almost every part of *Celery* can be extended or used on its own,
Custom pool implementations, serializers, compression schemes, logging,
schedulers, consumers, producers, broker transports, and much more.
It supports...
================
- **Message Transports**
- RabbitMQ_, Redis_, Amazon SQS, Google Pub/Sub
- **Concurrency**
- Prefork, Eventlet_, gevent_, single threaded (``solo``)
- **Result Stores**
- AMQP, Redis
- memcached
- SQLAlchemy, Django ORM
- Apache Cassandra, IronCache, Elasticsearch
- Google Cloud Storage
- **Serialization**
- *pickle*, *json*, *yaml*, *msgpack*.
- *zlib*, *bzip2* compression.
- Cryptographic message signing.
.. _`Eventlet`: http://eventlet.net/
.. _`gevent`: http://gevent.org/
.. _RabbitMQ: https://rabbitmq.com
.. _Redis: https://redis.io
.. _SQLAlchemy: http://sqlalchemy.org
Framework Integration
=====================
Celery is easy to integrate with web frameworks, some of which even have
integration packages:
+--------------------+------------------------+
| `Django`_ | not needed |
+--------------------+------------------------+
| `Pyramid`_ | `pyramid_celery`_ |
+--------------------+------------------------+
| `Pylons`_ | `celery-pylons`_ |
+--------------------+------------------------+
| `Flask`_ | not needed |
+--------------------+------------------------+
| `web2py`_ | `web2py-celery`_ |
+--------------------+------------------------+
| `Tornado`_ | `tornado-celery`_ |
+--------------------+------------------------+
| `FastAPI`_ | not needed |
+--------------------+------------------------+
The integration packages aren't strictly necessary, but they can make
development easier, and sometimes they add important hooks like closing
database connections at ``fork``.
.. _`Django`: https://djangoproject.com/
.. _`Pylons`: http://pylonsproject.org/
.. _`Flask`: https://flask.palletsprojects.com/
.. _`web2py`: http://web2py.com/
.. _`Bottle`: https://bottlepy.org/
.. _`Pyramid`: https://docs.pylonsproject.org/projects/pyramid/en/latest/
.. _`pyramid_celery`: https://pypi.org/project/pyramid_celery/
.. _`celery-pylons`: https://pypi.org/project/celery-pylons/
.. _`web2py-celery`: https://code.google.com/p/web2py-celery/
.. _`Tornado`: https://www.tornadoweb.org/
.. _`tornado-celery`: https://github.com/mher/tornado-celery/
.. _`FastAPI`: https://fastapi.tiangolo.com/
.. _celery-