index.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. <!DOCTYPE html>
  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="favicon.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="main.css"/>
  13. <link rel="stylesheet" href="trac.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. </head>
  24. <body>
  25. <div id="navbar">
  26. <div class="iStretch">
  27. <div class="link" id="current"><a href="#">Home</a></div>
  28. <div class="link"><a href="http://github.com/ask/celery">Code</a></div>
  29. <div class="link"><a href="docs/">Documentation</a></div>
  30. <div class="link"><a href="http://ask.github.com/celery/getting-started/">Tutorials</a></div>
  31. <div class="link"><a href="http://pypi.python.org/pypi/celery">Download</a></div>
  32. </div>
  33. </div>
  34. <div class="iStretch">
  35. <div id="topcontainer">
  36. <ul>
  37. <li>Background Processing
  38. <li>Distributed
  39. <li>Asynchronous/Synchronous
  40. <li>Concurrency
  41. <li>Periodic Tasks
  42. <li>Retries
  43. </ul>
  44. </div>
  45. <div id="contentcontainer">
  46. <div class="column">
  47. <h2>Distributed Task Queue</h2>
  48. <p>
  49. Celery is a task queue/job queue based on distributed message passing.
  50. It is focused on real-time operation, but support scheduling as well.</p>
  51. <p>The execution units, called tasks, are executed concurrently on one
  52. or more worker servers. Tasks can execute asynchronously (in the background) or
  53. synchronously (wait until ready).</p>
  54. <p>Celery is already used in production to process millions of tasks
  55. a day.</p>
  56. <p>Celery was originally created for use with Django, but is now
  57. usable from any Python project.
  58. It can also <a href="http://ask.github.com/celery/userguide/remote-tasks.html">operate with other languages</a> via webhooks.</p>
  59. <h3>Example</h3>
  60. <p>This is a simple task adding two numbers:</p>
  61. <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>
  62. <span class="nd">@task</span>
  63. <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>
  64. <span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>
  65. </pre></div>
  66. <p>You can execute the task in the background, or wait for it to
  67. finish:</p>
  68. <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>
  69. <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>
  70. <span class="mi">16</span>
  71. </pre></div>
  72. <h3>Getting Started</h3>
  73. <ol>
  74. <li>Install celery by download or <code>pip install -U celery</code></li>
  75. <li>Set up <a href="http://ask.github.com/celery/getting-started/broker-installation.html">RabbitMQ</a>
  76. or one of the <a href="http://ask.github.com/celery/tutorials/otherqueues.html">ghetto queue</a>
  77. solutions.
  78. <li>Select one of the following guides:
  79. <ul>
  80. <li><a href="http://ask.github.com/celery/getting-started/first-steps-with-python.html">First steps with Python</a></li>
  81. <li><a href="http://ask.github.com/celery/getting-started/first-steps-with-django.html">First steps with Django</a></li>
  82. </ul>
  83. </ol>
  84. <h3>Community</h3>
  85. <p>There is a <a href="http://groups.google.com/group/celery-users">mailing-list</a>
  86. available for general discussion.</p>
  87. <p>For those craving real, human interaction, there is also an IRC channel
  88. (<code>#celery</code> on <code>irc.freenode.net</code>).</p>
  89. <p>Finally, if you find a bug or would like to request a feature,
  90. please <a href="http://github.com/ask/celery/issues">submit an
  91. issue</a>.</p>
  92. <div class="hidden">
  93. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  94. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  95. </p>
  96. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  97. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  98. </p>
  99. <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  100. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  101. </p>
  102. </div>
  103. </div>
  104. <div class="column">
  105. <span class="newsitem">
  106. <h2>Celery 1.0 released!</h2>
  107. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 10.02.2010</h4>
  108. <p>Celery 1.0 has finally been released! It is available on <a
  109. href="http://pypi.python.org/pypi/celery/1.0.0">PyPI</a> for
  110. downloading. You can also install it via <code>pip install
  111. celery</code>. You can read the announcement <a href="celery_1.0_released.html">here</a>.
  112. <hr>
  113. </span>
  114. <span class="newsitem">
  115. <h2>1.0 is in beta.</h2>
  116. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 08.02.2010</h4>
  117. <p>1.0 is scheduled to be released this week! Please help us test the latest
  118. <a href="http://github.com/ask/celery/tarball/v1.0.0-pre4">release
  119. candiate</a> to make this happen. To upgrade from an earlier
  120. version, please read the <a href="http://ask.github.com/celery/changelog.html">changelog</a>.
  121. <hr>
  122. </span>
  123. <span class="newsitem">
  124. <h2>New website.</h2>
  125. <h4>By <a href="http://twitter.com/asksol">@asksol</a> on 08.02.2010</h4>
  126. <p>We finally got a home page. Big thanks to <a href="http://helmersworks.com">Jan Henrik Helmers</a>
  127. <hr>
  128. </span>
  129. </div>
  130. </div>
  131. <div id="credits">
  132. <div class="iStretch">Copyright (c) 2009-2010, <a href="http://twitter.com/asksol">Ask Solem</a> and
  133. <a href="http://github.com/ask/celery/blob/master/AUTHORS">contributors</a>.<br>
  134. Page design by <a href="http://www.helmersworks.com/">Jan Henrik Helmers</a>
  135. </div>
  136. </div>
  137. </div>
  138. </body>
  139. </html>