Package: celery
Version:5.3.6 (emerald-rush)Web:https://docs.celeryq.dev/en/stable/index.htmlDownload:https://pypi.org/project/celery/Source:https://github.com/celery/celery/Keywords:task, queue, job, async, rabbitmq, amqp, redis,
python, distributed, actorsDonationsThis project relies on your generous donations.If you are using Celery to create a commercial product, please consider becoming ourbackeror oursponsorto ensure Celery’s future.For enterpriseAvailable as part of the Tidelift Subscription.The maintainers ofceleryand 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.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’snode-celeryfor Node.js,
aPHP client,gocelery,gopher-celeryfor Go, andrusty-celeryfor 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.What do I need?Celery version 5.3.5 runs on:Python (3.8, 3.9, 3.10, 3.11, 3.12)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.Celeryis 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.Celerycan run on a single machine, on multiple machines, or even
across datacenters.Get StartedIf this is the first time you’re trying to use Celery, or you’re
new to Celery v5.3.5 coming from previous versions then you should read our
getting started tutorials:First steps with CeleryTutorial teaching you the bare minimum needed to get started with Celery.Next stepsA more complete overview, showing more features.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…SimpleCelery is easy to use and maintain, and doesnot need configuration files.It has an active, friendly community you can talk to for support,
like at ourmailing-list, or the IRC channel.Here’s one of the simplest applications you can make:fromceleryimportCeleryapp=Celery('hello',broker='amqp://guest@localhost//')@app.taskdefhello():return'hello world'Highly AvailableWorkers and clients will automatically retry in the event
of connection loss or failure, and some brokers support
HA in way ofPrimary/PrimaryorPrimary/Replicareplication.FastA single Celery process can process millions of tasks a minute,
with sub-millisecond round-trip latency (using RabbitMQ,
py-librabbitmq, and optimized settings).FlexibleAlmost every part ofCelerycan 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 TransportsRabbitMQ,Redis, Amazon SQSConcurrencyPrefork,Eventlet,gevent, single threaded (solo)Result StoresAMQP, RedismemcachedSQLAlchemy, Django ORMApache Cassandra, IronCache, ElasticsearchSerializationpickle,json,yaml,msgpack.zlib,bzip2compression.Cryptographic message signing.Framework IntegrationCelery is easy to integrate with web frameworks, some of which even have
integration packages:Djangonot neededPyramidpyramid_celeryPylonscelery-pylonsFlasknot neededweb2pyweb2py-celeryTornadotornado-celeryThe integration packages aren’t strictly necessary, but they can make
development easier, and sometimes they add important hooks like closing
database connections atfork.DocumentationThelatest documentationis hosted at Read The Docs, containing user guides,
tutorials, and an API reference.最新的中文文档托管在https://www.celerycn.io/中，包含用户指南、教程、API接口等。InstallationYou can install Celery either via the Python Package Index (PyPI)
or from source.To install usingpip:$ pip install -U CeleryBundlesCelery 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 thepipcommand-line by using brackets. Multiple bundles can be specified by
separating them by commas.$ pip install "celery[redis]"

$ pip install "celery[redis,auth,msgpack]"The following bundles are available:Serializerscelery[auth]:for using theauthsecurity serializer.celery[msgpack]:for using the msgpack serializer.celery[yaml]:for using the yaml serializer.Concurrencycelery[eventlet]:for using theeventletpool.celery[gevent]:for using thegeventpool.Transports and Backendscelery[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 thetask_remote_tracebacksfeature.celery[memcache]:for using Memcached as a result backend (usingpylibmc)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 (usingazure-storage)celery[s3]:for using S3 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 (usingpydocumentdb)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.You should probably not use this in your requirements, it’s here
for informational purposes only.Downloading and installing from sourceDownload the latest version of Celery from PyPI:https://pypi.org/project/celery/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 installThe last command must be executed as a privileged user if
you aren’t currently using a virtualenv.Using the development versionWith pipThe Celery development version also requires the development
versions ofkombu,amqp,billiard, andvine.You can install the latest snapshot of these using the following
pip commands:$ pip install https://github.com/celery/celery/zipball/main#egg=celery
$ pip install https://github.com/celery/billiard/zipball/main#egg=billiard
$ pip install https://github.com/celery/py-amqp/zipball/main#egg=amqp
$ pip install https://github.com/celery/kombu/zipball/main#egg=kombu
$ pip install https://github.com/celery/vine/zipball/main#egg=vineWith gitPlease see the Contributing section.Getting HelpMailing listFor discussions about the usage, development, and future of Celery,
please join thecelery-usersmailing list.IRCCome chat with us on IRC. The#celerychannel is located at theLibera Chatnetwork.Bug trackerIf you have any suggestions, bug reports, or annoyances please report them
to our issue tracker athttps://github.com/celery/celery/issues/Wikihttps://github.com/celery/celery/wikiCreditsContributorsThis project exists thanks to all the people who contribute. Development ofceleryhappens at GitHub:https://github.com/celery/celeryYou’re highly encouraged to participate in the development
ofcelery. If you don’t like GitHub (for some reason) you’re welcome
to send regular patches.Be sure to also read theContributing to Celerysection in the
documentation.BackersThank you to all our backers! 🙏 [Become a backer]SponsorsSupport this project by becoming a sponsor. Your logo will show up here with a
link to your website. [Become a sponsor]LicenseThis software is licensed under theNew BSD License. See theLICENSEfile in the top distribution directory for the full license text.