PKG-INFO 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550
  1. Metadata-Version: 2.1
  2. Name: celery
  3. Version: 4.2.1
  4. Summary: Distributed Task Queue.
  5. Home-page: http://celeryproject.org
  6. Author: Ask Solem
  7. Author-email: ask@celeryproject.org
  8. License: BSD
  9. Description: .. image:: http://docs.celeryproject.org/en/latest/_images/celery-banner-small.png
  10. |build-status| |coverage| |license| |wheel| |pyversion| |pyimp| |ocbackerbadge| |ocsponsorbadge|
  11. :Version: 4.2.1 (latentcall)
  12. :Web: http://celeryproject.org/
  13. :Download: https://pypi.org/project/celery/
  14. :Source: https://github.com/celery/celery/
  15. :Keywords: task, queue, job, async, rabbitmq, amqp, redis,
  16. python, distributed, actors
  17. --
  18. What's a Task Queue?
  19. ====================
  20. Task queues are used as a mechanism to distribute work across threads or
  21. machines.
  22. A task queue's input is a unit of work, called a task, dedicated worker
  23. processes then constantly monitor the queue for new work to perform.
  24. Celery communicates via messages, usually using a broker
  25. to mediate between clients and workers. To initiate a task a client puts a
  26. message on the queue, the broker then delivers the message to a worker.
  27. A Celery system can consist of multiple workers and brokers, giving way
  28. to high availability and horizontal scaling.
  29. Celery is written in Python, but the protocol can be implemented in any
  30. language. In addition to Python there's node-celery_ for Node.js,
  31. and a `PHP client`_.
  32. Language interoperability can also be achieved by using webhooks
  33. in such a way that the client enqueues an URL to be requested by a worker.
  34. .. _node-celery: https://github.com/mher/node-celery
  35. .. _`PHP client`: https://github.com/gjedeer/celery-php
  36. What do I need?
  37. ===============
  38. Celery version 4.2 runs on,
  39. - Python (2.7, 3.4, 3.5, 3.6)
  40. - PyPy (5.8)
  41. This is the last version to support Python 2.7,
  42. and from the next version (Celery 5.x) Python 3.5 or newer is required.
  43. If you're running an older version of Python, you need to be running
  44. an older version of Celery:
  45. - Python 2.6: Celery series 3.1 or earlier.
  46. - Python 2.5: Celery series 3.0 or earlier.
  47. - Python 2.4 was Celery series 2.2 or earlier.
  48. Celery is a project with minimal funding,
  49. so we don't support Microsoft Windows.
  50. Please don't open any issues related to that platform.
  51. *Celery* is usually used with a message broker to send and receive messages.
  52. The RabbitMQ, Redis transports are feature complete,
  53. but there's also experimental support for a myriad of other solutions, including
  54. using SQLite for local development.
  55. *Celery* can run on a single machine, on multiple machines, or even
  56. across datacenters.
  57. Get Started
  58. ===========
  59. If this is the first time you're trying to use Celery, or you're
  60. new to Celery 4.2 coming from previous versions then you should read our
  61. getting started tutorials:
  62. - `First steps with Celery`_
  63. Tutorial teaching you the bare minimum needed to get started with Celery.
  64. - `Next steps`_
  65. A more complete overview, showing more features.
  66. .. _`First steps with Celery`:
  67. http://docs.celeryproject.org/en/latest/getting-started/first-steps-with-celery.html
  68. .. _`Next steps`:
  69. http://docs.celeryproject.org/en/latest/getting-started/next-steps.html
  70. Celery is...
  71. =============
  72. - **Simple**
  73. Celery is easy to use and maintain, and does *not need configuration files*.
  74. It has an active, friendly community you can talk to for support,
  75. like at our `mailing-list`_, or the IRC channel.
  76. Here's one of the simplest applications you can make::
  77. from celery import Celery
  78. app = Celery('hello', broker='amqp://guest@localhost//')
  79. @app.task
  80. def hello():
  81. return 'hello world'
  82. - **Highly Available**
  83. Workers and clients will automatically retry in the event
  84. of connection loss or failure, and some brokers support
  85. HA in way of *Primary/Primary* or *Primary/Replica* replication.
  86. - **Fast**
  87. A single Celery process can process millions of tasks a minute,
  88. with sub-millisecond round-trip latency (using RabbitMQ,
  89. py-librabbitmq, and optimized settings).
  90. - **Flexible**
  91. Almost every part of *Celery* can be extended or used on its own,
  92. Custom pool implementations, serializers, compression schemes, logging,
  93. schedulers, consumers, producers, broker transports, and much more.
  94. It supports...
  95. ================
  96. - **Message Transports**
  97. - RabbitMQ_, Redis_, Amazon SQS
  98. - **Concurrency**
  99. - Prefork, Eventlet_, gevent_, single threaded (``solo``)
  100. - **Result Stores**
  101. - AMQP, Redis
  102. - memcached
  103. - SQLAlchemy, Django ORM
  104. - Apache Cassandra, IronCache, Elasticsearch
  105. - **Serialization**
  106. - *pickle*, *json*, *yaml*, *msgpack*.
  107. - *zlib*, *bzip2* compression.
  108. - Cryptographic message signing.
  109. .. _`Eventlet`: http://eventlet.net/
  110. .. _`gevent`: http://gevent.org/
  111. .. _RabbitMQ: https://rabbitmq.com
  112. .. _Redis: https://redis.io
  113. .. _SQLAlchemy: http://sqlalchemy.org
  114. Framework Integration
  115. =====================
  116. Celery is easy to integrate with web frameworks, some of which even have
  117. integration packages:
  118. +--------------------+------------------------+
  119. | `Django`_ | not needed |
  120. +--------------------+------------------------+
  121. | `Pyramid`_ | `pyramid_celery`_ |
  122. +--------------------+------------------------+
  123. | `Pylons`_ | `celery-pylons`_ |
  124. +--------------------+------------------------+
  125. | `Flask`_ | not needed |
  126. +--------------------+------------------------+
  127. | `web2py`_ | `web2py-celery`_ |
  128. +--------------------+------------------------+
  129. | `Tornado`_ | `tornado-celery`_ |
  130. +--------------------+------------------------+
  131. The integration packages aren't strictly necessary, but they can make
  132. development easier, and sometimes they add important hooks like closing
  133. database connections at ``fork``.
  134. .. _`Django`: https://djangoproject.com/
  135. .. _`Pylons`: http://pylonsproject.org/
  136. .. _`Flask`: http://flask.pocoo.org/
  137. .. _`web2py`: http://web2py.com/
  138. .. _`Bottle`: https://bottlepy.org/
  139. .. _`Pyramid`: http://docs.pylonsproject.org/en/latest/docs/pyramid.html
  140. .. _`pyramid_celery`: https://pypi.org/project/pyramid_celery/
  141. .. _`celery-pylons`: https://pypi.org/project/celery-pylons/
  142. .. _`web2py-celery`: https://code.google.com/p/web2py-celery/
  143. .. _`Tornado`: http://www.tornadoweb.org/
  144. .. _`tornado-celery`: https://github.com/mher/tornado-celery/
  145. .. _celery-documentation:
  146. Documentation
  147. =============
  148. The `latest documentation`_ is hosted at Read The Docs, containing user guides,
  149. tutorials, and an API reference.
  150. .. _`latest documentation`: http://docs.celeryproject.org/en/latest/
  151. .. _celery-installation:
  152. Installation
  153. ============
  154. You can install Celery either via the Python Package Index (PyPI)
  155. or from source.
  156. To install using ``pip``:
  157. ::
  158. $ pip install -U Celery
  159. .. _bundles:
  160. Bundles
  161. -------
  162. Celery also defines a group of bundles that can be used
  163. to install Celery and the dependencies for a given feature.
  164. You can specify these in your requirements or on the ``pip``
  165. command-line by using brackets. Multiple bundles can be specified by
  166. separating them by commas.
  167. ::
  168. $ pip install "celery[librabbitmq]"
  169. $ pip install "celery[librabbitmq,redis,auth,msgpack]"
  170. The following bundles are available:
  171. Serializers
  172. ~~~~~~~~~~~
  173. :``celery[auth]``:
  174. for using the ``auth`` security serializer.
  175. :``celery[msgpack]``:
  176. for using the msgpack serializer.
  177. :``celery[yaml]``:
  178. for using the yaml serializer.
  179. Concurrency
  180. ~~~~~~~~~~~
  181. :``celery[eventlet]``:
  182. for using the ``eventlet`` pool.
  183. :``celery[gevent]``:
  184. for using the ``gevent`` pool.
  185. Transports and Backends
  186. ~~~~~~~~~~~~~~~~~~~~~~~
  187. :``celery[librabbitmq]``:
  188. for using the librabbitmq C library.
  189. :``celery[redis]``:
  190. for using Redis as a message transport or as a result backend.
  191. :``celery[sqs]``:
  192. for using Amazon SQS as a message transport.
  193. :``celery[tblib``]:
  194. for using the ``task_remote_tracebacks`` feature.
  195. :``celery[memcache]``:
  196. for using Memcached as a result backend (using ``pylibmc``)
  197. :``celery[pymemcache]``:
  198. for using Memcached as a result backend (pure-Python implementation).
  199. :``celery[cassandra]``:
  200. for using Apache Cassandra as a result backend with DataStax driver.
  201. :``celery[couchbase]``:
  202. for using Couchbase as a result backend.
  203. :``celery[elasticsearch]``:
  204. for using Elasticsearch as a result backend.
  205. :``celery[riak]``:
  206. for using Riak as a result backend.
  207. :``celery[zookeeper]``:
  208. for using Zookeeper as a message transport.
  209. :``celery[sqlalchemy]``:
  210. for using SQLAlchemy as a result backend (*supported*).
  211. :``celery[pyro]``:
  212. for using the Pyro4 message transport (*experimental*).
  213. :``celery[slmq]``:
  214. for using the SoftLayer Message Queue transport (*experimental*).
  215. :``celery[consul]``:
  216. for using the Consul.io Key/Value store as a message transport or result backend (*experimental*).
  217. :``celery[django]``:
  218. specifies the lowest version possible for Django support.
  219. You should probably not use this in your requirements, it's here
  220. for informational purposes only.
  221. .. _celery-installing-from-source:
  222. Downloading and installing from source
  223. --------------------------------------
  224. Download the latest version of Celery from PyPI:
  225. https://pypi.org/project/celery/
  226. You can install it by doing the following,:
  227. ::
  228. $ tar xvfz celery-0.0.0.tar.gz
  229. $ cd celery-0.0.0
  230. $ python setup.py build
  231. # python setup.py install
  232. The last command must be executed as a privileged user if
  233. you aren't currently using a virtualenv.
  234. .. _celery-installing-from-git:
  235. Using the development version
  236. -----------------------------
  237. With pip
  238. ~~~~~~~~
  239. The Celery development version also requires the development
  240. versions of ``kombu``, ``amqp``, ``billiard``, and ``vine``.
  241. You can install the latest snapshot of these using the following
  242. pip commands:
  243. ::
  244. $ pip install https://github.com/celery/celery/zipball/master#egg=celery
  245. $ pip install https://github.com/celery/billiard/zipball/master#egg=billiard
  246. $ pip install https://github.com/celery/py-amqp/zipball/master#egg=amqp
  247. $ pip install https://github.com/celery/kombu/zipball/master#egg=kombu
  248. $ pip install https://github.com/celery/vine/zipball/master#egg=vine
  249. With git
  250. ~~~~~~~~
  251. Please see the Contributing section.
  252. .. _getting-help:
  253. Getting Help
  254. ============
  255. .. _mailing-list:
  256. Mailing list
  257. ------------
  258. For discussions about the usage, development, and future of Celery,
  259. please join the `celery-users`_ mailing list.
  260. .. _`celery-users`: https://groups.google.com/group/celery-users/
  261. .. _irc-channel:
  262. IRC
  263. ---
  264. Come chat with us on IRC. The **#celery** channel is located at the `Freenode`_
  265. network.
  266. .. _`Freenode`: https://freenode.net
  267. .. _bug-tracker:
  268. Bug tracker
  269. ===========
  270. If you have any suggestions, bug reports, or annoyances please report them
  271. to our issue tracker at https://github.com/celery/celery/issues/
  272. .. _wiki:
  273. Wiki
  274. ====
  275. https://wiki.github.com/celery/celery/
  276. Credits
  277. =======
  278. .. _contributing-short:
  279. Contributors
  280. ------------
  281. This project exists thanks to all the people who contribute. Development of
  282. `celery` happens at GitHub: https://github.com/celery/celery
  283. You're highly encouraged to participate in the development
  284. of `celery`. If you don't like GitHub (for some reason) you're welcome
  285. to send regular patches.
  286. Be sure to also read the `Contributing to Celery`_ section in the
  287. documentation.
  288. .. _`Contributing to Celery`:
  289. http://docs.celeryproject.org/en/master/contributing.html
  290. |oc-contributors|
  291. .. |oc-contributors| image:: https://opencollective.com/celery/contributors.svg?width=890&button=false
  292. :target: https://github.com/celery/celery/graphs/contributors
  293. Backers
  294. -------
  295. Thank you to all our backers! 🙏 [`Become a backer`_]
  296. .. _`Become a backer`: https://opencollective.com/celery#backer
  297. |oc-backers|
  298. .. |oc-backers| image:: https://opencollective.com/celery/backers.svg?width=890
  299. :target: https://opencollective.com/celery#backers
  300. Sponsors
  301. --------
  302. Support this project by becoming a sponsor. Your logo will show up here with a
  303. link to your website. [`Become a sponsor`_]
  304. .. _`Become a sponsor`: https://opencollective.com/celery#sponsor
  305. |oc-sponsors|
  306. .. |oc-sponsors| image:: https://opencollective.com/celery/sponsor/0/avatar.svg
  307. :target: https://opencollective.com/celery/sponsor/0/website
  308. .. _license:
  309. License
  310. =======
  311. This software is licensed under the `New BSD License`. See the ``LICENSE``
  312. file in the top distribution directory for the full license text.
  313. .. # vim: syntax=rst expandtab tabstop=4 shiftwidth=4 shiftround
  314. .. |build-status| image:: https://secure.travis-ci.org/celery/celery.png?branch=master
  315. :alt: Build status
  316. :target: https://travis-ci.org/celery/celery
  317. .. |coverage| image:: https://codecov.io/github/celery/celery/coverage.svg?branch=master
  318. :target: https://codecov.io/github/celery/celery?branch=master
  319. .. |license| image:: https://img.shields.io/pypi/l/celery.svg
  320. :alt: BSD License
  321. :target: https://opensource.org/licenses/BSD-3-Clause
  322. .. |wheel| image:: https://img.shields.io/pypi/wheel/celery.svg
  323. :alt: Celery can be installed via wheel
  324. :target: https://pypi.org/project/celery/
  325. .. |pyversion| image:: https://img.shields.io/pypi/pyversions/celery.svg
  326. :alt: Supported Python versions.
  327. :target: https://pypi.org/project/celery/
  328. .. |pyimp| image:: https://img.shields.io/pypi/implementation/celery.svg
  329. :alt: Support Python implementations.
  330. :target: https://pypi.org/project/celery/
  331. .. |ocbackerbadge| image:: https://opencollective.com/celery/backers/badge.svg
  332. :alt: Backers on Open Collective
  333. :target: #backers
  334. .. |ocsponsorbadge| image:: https://opencollective.com/celery/sponsors/badge.svg
  335. :alt: Sponsors on Open Collective
  336. :target: #sponsors
  337. Keywords: task job queue distributed messaging actor
  338. Platform: any
  339. Classifier: Development Status :: 5 - Production/Stable
  340. Classifier: License :: OSI Approved :: BSD License
  341. Classifier: Topic :: System :: Distributed Computing
  342. Classifier: Topic :: Software Development :: Object Brokering
  343. Classifier: Programming Language :: Python
  344. Classifier: Programming Language :: Python :: 2
  345. Classifier: Programming Language :: Python :: 2.7
  346. Classifier: Programming Language :: Python :: 3
  347. Classifier: Programming Language :: Python :: 3.4
  348. Classifier: Programming Language :: Python :: 3.5
  349. Classifier: Programming Language :: Python :: 3.6
  350. Classifier: Programming Language :: Python :: Implementation :: CPython
  351. Classifier: Programming Language :: Python :: Implementation :: PyPy
  352. Classifier: Operating System :: OS Independent
  353. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
  354. Provides-Extra: consul
  355. Provides-Extra: elasticsearch
  356. Provides-Extra: pymemcache
  357. Provides-Extra: sqlalchemy
  358. Provides-Extra: riak
  359. Provides-Extra: pyro
  360. Provides-Extra: gevent
  361. Provides-Extra: librabbitmq
  362. Provides-Extra: msgpack
  363. Provides-Extra: redis
  364. Provides-Extra: solar
  365. Provides-Extra: tblib
  366. Provides-Extra: cassandra
  367. Provides-Extra: dynamodb
  368. Provides-Extra: yaml
  369. Provides-Extra: zookeeper
  370. Provides-Extra: couchbase
  371. Provides-Extra: couchdb
  372. Provides-Extra: mongodb
  373. Provides-Extra: eventlet
  374. Provides-Extra: slmq
  375. Provides-Extra: memcache
  376. Provides-Extra: django
  377. Provides-Extra: auth
  378. Provides-Extra: sqs