Celery ORG

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

Official Announcement _

CloudAMQP _ is an 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 _ 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 _ 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.

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.

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

• First steps with Celery_

• Next steps_

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

It has an active, friendly community you can talk to for support,
like at our mailing-list_, or the IRC channel.

- Prefork, Eventlet_, gevent_, single threaded (solo)

.. _Eventlet: https://eventlet.net/
.. _gevent: https://gevent.org/

+--------------------+------------------------+
| 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: https://pylonsproject.org/
.. _Flask: https://flask.palletsprojects.com/
.. _web2py: https://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/

The latest documentation_ is hosted at Read The Docs, containing user guides,
tutorials, and an API reference.

.. _latest documentation: https://docs.celeryq.dev/en/latest/

To install using pip:

You can specify these in your requirements or on the pip
command-line by using brackets. Multiple bundles can be specified by
separating them by commas.

:celery[auth]:
for using the auth security serializer.

:celery[msgpack]:
for using the msgpack serializer.

:celery[yaml]:
for using the yaml serializer.

:celery[eventlet]:
for using the eventlet pool.

:celery[gevent]:
for using the gevent pool.

:celery[amqp]:
for using the RabbitMQ amqp python library.

:celery[redis]:
for using Redis as a message transport or as a result backend.

:celery[sqs]:
for using Amazon SQS as a message transport.

:celery[tblib]:
for using the task_remote_tracebacks feature.

:celery[memcache]:
for using Memcached as a result backend (using pylibmc)

:celery[pymemcache]:
for using Memcached as a result backend (pure-Python implementation).

:celery[cassandra]:
for using Apache Cassandra/Astra DB as a result backend with the DataStax driver.

:celery[azureblockblob]:
for using Azure Storage as a result backend (using azure-storage)

:celery[s3]:
for using S3 Storage as a result backend.

:celery[gcs]:
for using Google Cloud Storage as a result backend.

:celery[couchbase]:
for using Couchbase as a result backend.

:celery[arangodb]:
for using ArangoDB as a result backend.

:celery[elasticsearch]:
for using Elasticsearch as a result backend.

:celery[riak]:
for using Riak as a result backend.

:celery[cosmosdbsql]:
for using Azure Cosmos DB as a result backend (using pydocumentdb)

:celery[zookeeper]:
for using Zookeeper as a message transport.

:celery[sqlalchemy]:
for using SQLAlchemy as a result backend (*supported*).

:celery[pyro]:
for using the Pyro4 message transport (*experimental*).

:celery[slmq]:
for using the SoftLayer Message Queue transport (*experimental*).

:celery[consul]:
for using the Consul.io Key/Value store as a message transport or result backend (*experimental*).

:celery[django]:
specifies the lowest version possible for Django support.

:celery[gcpubsub]:
for using Google Pub/Sub as a message transport.

The Celery development version also requires the development
versions of kombu, amqp, billiard, and vine.

For discussions about the usage, development, and future of Celery,
please join the celery-users_ mailing list.

.. _celery-users: https://groups.google.com/group/celery-users/

Come chat with us on IRC. The #celery channel is located at the
Libera Chat_ network.

.. _Libera Chat: https://libera.chat/

This project exists thanks to all the people who contribute. Development of
celery happens at GitHub: https://github.com/celery/celery

You're highly encouraged to participate in the development
of celery. If you don't like GitHub (for some reason) you're welcome
to send regular patches.

Be sure to also read the Contributing to Celery_ section in the
documentation.

.. _Contributing to Celery:
https://docs.celeryq.dev/en/stable/contributing.html

Thank you to all our backers! 🙏 [Become a backer_]

.. _Become a backer`: https://opencollective.com/celery#backer

|oc-backers|

.. |oc-backers| image:: https://opencollective.co

…

Collapse