installation.txt 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. .. _celery-installation:
  2. Installation
  3. ============
  4. You can install Celery either via the Python Package Index (PyPI)
  5. or from source.
  6. To install using `pip`,::
  7. $ pip install -U Celery
  8. To install using `easy_install`,::
  9. $ easy_install -U Celery
  10. .. _bundles:
  11. Bundles
  12. -------
  13. Celery also defines a group of bundles that can be used
  14. to install Celery and the dependencies for a given feature.
  15. You can specify these in your requirements or on the ``pip`` comand-line
  16. by using brackets. Multiple bundles can be specified by separating them by
  17. commas.
  18. .. code-block:: console
  19. $ pip install "celery[librabbitmq]"
  20. $ pip install "celery[librabbitmq,redis,auth,msgpack]"
  21. The following bundles are available:
  22. Serializers
  23. ~~~~~~~~~~~
  24. :celery[auth]:
  25. for using the auth serializer.
  26. :celery[msgpack]:
  27. for using the msgpack serializer.
  28. :celery[yaml]:
  29. for using the yaml serializer.
  30. Concurrency
  31. ~~~~~~~~~~~
  32. :celery[eventlet]:
  33. for using the eventlet pool.
  34. :celery[gevent]:
  35. for using the gevent pool.
  36. :celery[threads]:
  37. for using the thread pool.
  38. Transports and Backends
  39. ~~~~~~~~~~~~~~~~~~~~~~~
  40. :celery[librabbitmq]:
  41. for using the librabbitmq C library.
  42. :celery[redis]:
  43. for using Redis as a message transport or as a result backend.
  44. :celery[mongodb]:
  45. for using MongoDB as a message transport (*experimental*),
  46. or as a result backend (*supported*).
  47. :celery[sqs]:
  48. for using Amazon SQS as a message transport (*experimental*).
  49. :celery[memcache]:
  50. for using memcached as a result backend (using pylibmc)
  51. :celery[pymemcache]:
  52. for using memcached as a result backend (pure-python implementation).
  53. :celery[cassandra]:
  54. for using Apache Cassandra as a result backend with DataStax driver.
  55. :celery[couchdb]:
  56. for using CouchDB as a message transport (*experimental*).
  57. :celery[couchbase]:
  58. for using CouchBase as a result backend.
  59. :celery[elasticsearch]
  60. for using Elasticsearch as a result backend.
  61. :celery[riak]:
  62. for using Riak as a result backend.
  63. :celery[beanstalk]:
  64. for using Beanstalk as a message transport (*experimental*).
  65. :celery[zookeeper]:
  66. for using Zookeeper as a message transport.
  67. :celery[zeromq]:
  68. for using ZeroMQ as a message transport (*experimental*).
  69. :celery[sqlalchemy]:
  70. for using SQLAlchemy as a message transport (*experimental*),
  71. or as a result backend (*supported*).
  72. :celery[pyro]:
  73. for using the Pyro4 message transport (*experimental*).
  74. :celery[slmq]:
  75. for using the SoftLayer Message Queue transport (*experimental*).
  76. .. _celery-installing-from-source:
  77. Downloading and installing from source
  78. --------------------------------------
  79. Download the latest version of Celery from
  80. http://pypi.python.org/pypi/celery/
  81. You can install it by doing the following,::
  82. $ tar xvfz celery-0.0.0.tar.gz
  83. $ cd celery-0.0.0
  84. $ python setup.py build
  85. # python setup.py install
  86. The last command must be executed as a privileged user if
  87. you are not currently using a virtualenv.
  88. .. _celery-installing-from-git:
  89. Using the development version
  90. -----------------------------
  91. With pip
  92. ~~~~~~~~
  93. The Celery development version also requires the development
  94. versions of ``kombu``, ``amqp`` and ``billiard``.
  95. You can install the latest snapshot of these using the following
  96. pip commands::
  97. $ pip install https://github.com/celery/celery/zipball/master#egg=celery
  98. $ pip install https://github.com/celery/billiard/zipball/master#egg=billiard
  99. $ pip install https://github.com/celery/py-amqp/zipball/master#egg=amqp
  100. $ pip install https://github.com/celery/kombu/zipball/master#egg=kombu
  101. With git
  102. ~~~~~~~~
  103. Please the Contributing section.