index.html 5.9 KB

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