Distributed Task Queue (development branch)
Clone or download
othalla and auvipy Small code improvements (#5239)
* small cleanup in events.cursemon

* small cleanup in celery.__init__

* small cleanup in loaders.base

* small cleanup in celery canvas
Latest commit 16be4ff Dec 18, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Adds Github pull request template Oct 24, 2016
celery Small code improvements (#5239) Dec 18, 2018
docker Update CONTRIBUTING.rst, fix tests and update Dockerfile. Related to #… Dec 1, 2018
docs Add s3 result backend (#5137) Dec 14, 2018
examples Make __all__ immutable. (#4315) Oct 7, 2017
extra Documentation - add example systemd celerybeat.service file (#5134) Nov 14, 2018
requirements Add s3 result backend (#5137) Dec 14, 2018
t Warn Riak backend users for possible 3.7 incompatibilities (#5236) Dec 16, 2018
.bumpversion.cfg Bump version: 4.2.0rc4 → 4.2.0 Jun 10, 2018
.cookiecutterrc Adds .cookiecutterrc Jul 6, 2016
.coveragerc Report coverage for all result backends. Oct 6, 2017
.editorconfig Updates, fixes, and improvements to documentation (#3976) Apr 15, 2017
.gitignore Fix grammar, update .gitignore (#3887) Mar 14, 2017
.travis.yml Py37 matrix (#4859) Dec 15, 2018
CONTRIBUTING.rst Update CONTRIBUTING.rst, fix tests and update Dockerfile. Related to #… Dec 1, 2018
CONTRIBUTORS.txt Add s3 result backend (#5137) Dec 14, 2018
Changelog Update CONTRIBUTING.rst, fix tests and update Dockerfile. Related to #… Dec 1, 2018
LICENSE Prefer https over http when available (#3966) Apr 15, 2017
MANIFEST.in WIP: Sphinx autodoc picks up tasks automatically only if `undoc-membe… Mar 10, 2018
Makefile Fix a couple typos (#4156) Jul 26, 2017
README.rst Add s3 result backend (#5137) Dec 14, 2018
TODO Use https for github and wikipedia links Mar 20, 2016
appveyor.yml enable pip cache in appveyor build (#4546) Feb 20, 2018
bandit.json Regenarated bandit.json. Aug 19, 2018
setup.cfg Fix flake8 due latest release (#5141) Oct 24, 2018
setup.py Add s3 result backend (#5137) Dec 14, 2018
tox.ini Py37 matrix (#4859) Dec 15, 2018



Build status coverage BSD License Celery can be installed via wheel Supported Python versions. Support Python implementations. Backers on Open Collective Sponsors on Open Collective

Version:4.2.1 (windowlicker)
Keywords:task, queue, job, async, rabbitmq, amqp, redis, python, distributed, actors


This project relies on your generous donations.

If you are using Celery to create a commercial product, please consider becoming our backer or our sponsor to ensure Celery's future.



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, and a PHP client.

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.

What do I need?

Celery version 4.2 runs on,

  • Python (2.7, 3.4, 3.5, 3.6)
  • PyPy (6.0)

This is the last version to support Python 2.7, and from the next version (Celery 5.x) Python 3.5 or newer is required.

If you're running an older version of Python, you need to be running an older version of Celery:

  • Python 2.6: Celery series 3.1 or earlier.
  • Python 2.5: Celery series 3.0 or earlier.
  • Python 2.4 was Celery series 2.2 or earlier.

Celery is a project with minimal funding, so we don't support Microsoft Windows. 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 4.2 coming from previous versions then you should read our getting started tutorials:

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:

    from celery import Celery
    app = Celery('hello', broker='amqp://guest@localhost//')
    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

  • Concurrency

  • Result Stores

    • AMQP, Redis
    • memcached
    • SQLAlchemy, Django ORM
    • Apache Cassandra, IronCache, Elasticsearch
  • Serialization

    • pickle, json, yaml, msgpack.
    • zlib, bzip2 compression.
    • Cryptographic message signing.

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

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.


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


You can install Celery either via the Python Package Index (PyPI) or from source.

To install using pip:

$ pip install -U Celery


Celery also defines a group of bundles that can be used to install Celery and the dependencies for a given feature.

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.

$ pip install "celery[librabbitmq]"

$ pip install "celery[librabbitmq,redis,auth,msgpack]"

The following bundles are available:


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.

Transports and Backends


for using the librabbitmq C library.


for using Redis as a message transport or as a result backend.


for using Amazon SQS as a message transport.


for using the task_remote_tracebacks feature.


for using Memcached as a result backend (using pylibmc)


for using Memcached as a result backend (pure-Python implementation).


for using Apache Cassandra as a result backend with DataStax driver.


for using Azure Storage as a result backend (using azure-storage)


for using S3 Storage as a result backend.


for using Couchbase as a result backend.


for using Elasticsearch as a result backend.


for using Riak as a result backend.


for using Azure Cosmos DB as a result backend (using pydocumentdb)


for using Zookeeper as a message transport.


for using SQLAlchemy as a result backend (supported).


for using the Pyro4 message transport (experimental).


for using the SoftLayer Message Queue transport (experimental).


for using the Consul.io Key/Value store as a message transport or result backend (experimental).


specifies the lowest version possible for Django support.

You should probably not use this in your requirements, it's here for informational purposes only.

Downloading and installing from source

Download the latest version of Celery from PyPI:


You can install it by doing the following,:

$ tar xvfz celery-0.0.0.tar.gz
$ cd celery-0.0.0
$ python setup.py build
# python setup.py install

The last command must be executed as a privileged user if you aren't currently using a virtualenv.

Using the development version

With pip

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

You can install the latest snapshot of these using the following pip commands:

$ pip install https://github.com/celery/celery/zipball/master#egg=celery
$ pip install https://github.com/celery/billiard/zipball/master#egg=billiard
$ pip install https://github.com/celery/py-amqp/zipball/master#egg=amqp
$ pip install https://github.com/celery/kombu/zipball/master#egg=kombu
$ pip install https://github.com/celery/vine/zipball/master#egg=vine

With git

Please see the Contributing section.

Getting Help

Mailing list

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


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

Bug tracker

If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/celery/celery/issues/





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.



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



Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]



This software is licensed under the New BSD License. See the LICENSE file in the top distribution directory for the full license text.