index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="keywords" content="task queue, job queue, asynchronous, rabbitmq, amqp,
  6. redis, django, python, webhooks, queue, distributed">
  7. <meta name="description" content="open source distributed task queue" >
  8. <link rel="icon" type="image/png" href="favicon0.png">
  9. <meta name="viewport" content="width=320, user-scalable=no">
  10. <link rel="apple-touch-icon" href="favicon_64.png"/>
  11. <title>Celery - The Distributed Task Queue</title>
  12. <link rel="stylesheet" href="main0000.css"/>
  13. <link rel="stylesheet" href="trac0000.css"/>
  14. <script type="text/javascript">
  15. var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
  16. document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
  17. </script>
  18. <script type="text/javascript">
  19. try {
  20. var pageTracker = _gat._getTracker("UA-12986238-1");
  21. pageTracker._trackPageview();
  22. } catch(err) {}</script>
  23. <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
  24. <!--[if IE 8]>
  25. <style>
  26. .column{
  27. display:inline;
  28. zoom: 1;
  29. width: 500px;
  30. }
  31. </style>
  32. <![endif]-->
  33. </head>
  34. <body>
  35. <div id="navbar">
  36. <div class="iStretch">
  37. <div class="link" id="current"><a href="">Home</a></div>
  38. <div class="link"><a href="http://github.com/ask/celery">Code</a></div>
  39. <div class="link"><a href="http://celeryq.org/docs/">Documentation</a></div>
  40. <div class="link"><a href="http://celeryq.org/docs/getting-started/">Tutorials</a></div>
  41. <div class="link"><a href="http://pypi.python.org/pypi/celery">Download</a></div>
  42. </div>
  43. </div>
  44. <div class="iStretch">
  45. <div id="topcontainer">
  46. <ul>
  47. <li>Background Processing
  48. <li>Distributed
  49. <li>Asynchronous/Synchronous
  50. <li>Concurrency
  51. <li>Periodic Tasks
  52. <li>Retries
  53. </ul>
  54. </div>
  55. <div id="contentcontainer">
  56. <div class="column">
  57. <h2>Distributed Task Queue</h2>
  58. <p> Celery is an open source asynchronous task queue/job queue based on distributed message
  59. passing. It is focused on real-time operation, but supports scheduling as well.</p>
  60. <p>The execution units, called tasks, are executed concurrently on a single or
  61. more worker servers. Tasks can execute asynchronously (in the background) or synchronously
  62. (wait until ready).</p>
  63. <p>Celery is already used in production to process millions of tasks a day.</p>
  64. <p>Celery is written in Python, but the protocol can be implemented in any
  65. language.
  66. It can also <a href="http://celeryq.org/docs/userguide/remote-tasks.html"
  67. >operate with other languages</a> using webhooks.</p>
  68. <p>The recommended message broker is <a href="http://rabbitmq.com/">RabbitMQ</a>,
  69. but support for <a href="http://redisdb.com/">Redis</a> and databases
  70. is also available.</p>
  71. <p>You may also be pleased to know that full
  72. <a href="http://pypi.python.org/pypi/django-celery">Django integration</a> exists,
  73. delivered by the django-celery package.</p>
  74. <h3>Example</h3>
  75. <p>This is a simple task adding two numbers:</p>
  76. <div class="highlight"><pre><span class="kn">from</span> <span class="nn">celery.decorators</span> <span class="kn">import</span> <span class="n">task</span>
  77. <span class="nd">@task</span>
  78. <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
  79. <span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>
  80. </pre></div>
  81. <p>You can execute the task in the background, or wait for it to
  82. finish:</p>
  83. <div class="highlight"><pre><span class="o">&gt;&gt;&gt;</span> <span class="n">result</span> <span class="o">=</span> <span class="n">add</span><span class="o">.</span><span class="n">delay</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">8</span><span class="p">)</span>
  84. <span class="o">&gt;&gt;&gt;</span> <span class="n">result</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span> <span class="c"># wait for and return the result</span>
  85. <span class="mi">16</span>
  86. </pre></div>
  87. <h3>Getting Started</h3>
  88. <ol>
  89. <li>Install celery by download or <code>pip install -U celery</code></li>
  90. <li>Set up <a href="http://celeryq.org/docs/getting-started/broker-installation.html">RabbitMQ</a>
  91. or one of the <a href="http://celeryq.org/docs/tutorials/otherqueues.html">ghetto queue</a>
  92. solutions.
  93. <li>Select one of the following guides:
  94. <ul>
  95. <li><a
  96. href="http://celeryq.org/docs/getting-started/first-steps-with-celery.html">First steps with Python</a></li>
  97. <li><a href="http://celeryq.org/docs/django-celery/getting-started/first-steps-with-django.html">First steps with Django</a></li>
  98. </ul>
  99. </ol>
  100. <h3>Community</h3>
  101. <p>There is a <a href="http://groups.google.com/group/celery-users">mailing-list</a>
  102. available for general discussion.</p>
  103. <p>For those craving real, human interaction, there is also an IRC channel
  104. (<code>#celery</code> on <code>irc.freenode.net</code>).</p>
  105. <p>Finally, if you find a bug or would like to request a feature,
  106. please <a href="http://github.com/ask/celery/issues">submit an
  107. issue</a>.</p>
  108. <div class="hidden">
  109. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  110. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  111. </p>
  112. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  113. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  114. </p>
  115. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  116. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  117. </p>
  118. </div>
  119. </div>
  120. <div class="column">
  121. <span class="newsitem">
  122. <h2>Celery 2.0 released!</h2>
  123. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-07-02.</h4>
  124. <p>We're proud to announce the release of Celery 2.0. This version replaces
  125. the Django ORM with SQLAlchemy as the database result store. With this, Celery no
  126. longer depends on Django. Django integration is now available as a separate package
  127. called <a href="http://pypi.python.org/pypi/django-celery">django-celery</a>.
  128. </p>
  129. <p>In addition there are a lot of new features: a curses monitor, time
  130. limits, complex crontab expressions, callbacks, simplified routing,
  131. and more. Everything is detailed in the <a
  132. href="http://celeryq.org/docs/changelog.html#id1">changelog</a>,
  133. so be sure to read it before upgrading.</p>
  134. </span>
  135. <span class="newsitem">
  136. <h2>Celery 1.0.6 released!</h2>
  137. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-06-30.</h4>
  138. <p>RabbitMQ 1.8.0 came with stricter equivalence checks that broke the
  139. AMQP result backend, this release resolves this. If you've already used
  140. the AMQP backend you need to delete the previous declarations. For
  141. instructions please read the full
  142. <a href="http://celeryproject.org/docs/changelog.html">changelog</a>.
  143. Download from <a href="http://pypi.python.org/pypi/celery/1.0.6">PyPI</a>,
  144. or simply install the upgrade using <code>pip install -U celery==1.0.6</code>.
  145. <hr>
  146. </span>
  147. <span class="newsitem">
  148. <h2>Celery 1.0.5 released!</h2>
  149. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-06-01.</h4>
  150. <p>This release contains some important bugfixes related to shutdown and
  151. broker connection loss, as well as some other minor fixes. Also
  152. AbortableTask has been added to contrib. Please read the full <a href="http://celeryproject.org/docs/changelog.html">changelog</a>
  153. before you upgrade. Download from <a href="http://pypi.python.org/pypi/celery/1.0.5">PyPI</a>,
  154. or simply install the upgrade using <code>pip install -U celery</code>.
  155. <hr>
  156. </span>
  157. <span class="newsitem">
  158. <h2>Celery 1.0.3 released!</h2>
  159. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-05-15.</h4>
  160. <p>This release contains a drastic improvement in reliability and
  161. performance. Please read the full <a href="http://celeryproject.org/docs/changelog.html">changelog</a>
  162. before you upgrade. Download from <a href="http://pypi.python.org/pypi/celery/1.0.3">PyPI</a>,
  163. or simply install the upgrade using <code>pip install -U celery</code>.
  164. <hr>
  165. </span>
  166. <span class="newsitem">
  167. <h2>Celery 1.0.1 released!</h2>
  168. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-03-20.</h4>
  169. <p>This is a bugfix release and has some important changes to the
  170. shutdown procedure. Also improved compatibility with Windows and Python
  171. 2.4. Read the full <a href="http://celeryproject.org/docs/changelog.html">Changelog</a>
  172. for more information. Download from <a
  173. href="http://pypi.python.org/pypi/celery/1.0.1">PyPI</a>,
  174. or simply install the upgrade using <code>pip install -U celery</code>.
  175. <hr>
  176. </span>
  177. <span class="newsitem">
  178. <h2>Celery 1.0 released!</h2>
  179. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-02-10</h4>
  180. <p>Celery 1.0 has finally been released! It is available on <a
  181. href="http://pypi.python.org/pypi/celery/1.0.0">PyPI</a> for
  182. downloading. You can also install it via <code>pip install
  183. celery</code>. You can read the announcement <a href="http://celeryproject.org/celery_1.0_released.html">here</a>.
  184. <hr>
  185. </span>
  186. <span class="newsitem">
  187. <h2>1.0 is in beta.</h2>
  188. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-02-08</h4>
  189. <p>1.0 is scheduled to be released this week! Please help us test the latest
  190. <a href="http://github.com/ask/celery/tarball/v1.0.0-pre4">release
  191. candiate</a> to make this happen. To upgrade from an earlier
  192. version, please read the <a href="http://celeryq.org/docs/changelog.html">changelog</a>.
  193. <hr>
  194. </span>
  195. <span class="newsitem">
  196. <h2>New website.</h2>
  197. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 2010-02-08</h4>
  198. <p>We finally got a home page. Big thanks to <a href="http://helmersworks.com/">Jan Henrik Helmers</a>
  199. <hr>
  200. </span>
  201. </div>
  202. </div>
  203. <div id="credits">
  204. <ul>
  205. <li>
  206. <strong>Copyright (c) 2009-2010</strong>
  207. <span><a href="http://twitter.com/asksol">Ask Solem</a> and
  208. <a href="http://github.com/ask/celery/blob/master/AUTHORS">contributors</a>.</span>
  209. </li>
  210. <li>
  211. <strong>Web Design</strong>
  212. <span><a href="http://www.helmersworks.com/">Jan Henrik Helmers</a></span>
  213. </li>
  214. </ul>
  215. </div>
  216. </div>
  217. </body>
  218. </html>
  219. <!-- This document saved from http://celeryproject.org/ -->