Autogenerated documentation for github.

genindex.html

@@ -513,14 +513,15 @@
 <dt><a href="reference/celery.managers.html#celery.managers.TaskManager">TaskManager (class in celery.managers)</a></dt>
 <dt><a href="reference/celery.models.html#TaskMeta">TaskMeta (built-in class)</a></dt>
 <dt><a href="reference/celery.pool.html#celery.pool.TaskPool">TaskPool (class in celery.pool)</a></dt>
-<dt><a href="reference/celery.messaging.html#celery.messaging.TaskPublisher">TaskPublisher (class in celery.messaging)</a></dt></dl></td><td width="33%" valign="top"><dl>
-<dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry">TaskRegistry (class in celery.registry)</a></dt>
+<dt><a href="reference/celery.messaging.html#celery.messaging.TaskPublisher">TaskPublisher (class in celery.messaging)</a></dt>
+<dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry">TaskRegistry (class in celery.registry)</a></dt></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.AlreadyRegistered">TaskRegistry.AlreadyRegistered</a></dt>
 <dt><a href="reference/celery.registry.html#celery.registry.TaskRegistry.NotRegistered">TaskRegistry.NotRegistered</a></dt>
 <dt><a href="reference/celery.task.html#celery.task.TaskSet">TaskSet (class in celery.task)</a></dt>
 <dt><a href="reference/celery.result.html#celery.result.TaskSetResult.taskset_id">taskset_id (celery.result.TaskSetResult attribute)</a></dt>
 <dt><a href="reference/celery.result.html#celery.result.TaskSetResult">TaskSetResult (class in celery.result)</a></dt>
 <dt><a href="reference/celery.worker.html#celery.worker.TaskWrapper">TaskWrapper (class in celery.worker)</a></dt>
+<dt><a href="reference/celery.pool.html#celery.pool.TaskPool.terminate">terminate() (celery.pool.TaskPool method)</a></dt>
 <dt><a href="reference/celery.timer.html#celery.timer.EventTimer.tick">tick() (celery.timer.EventTimer method)</a></dt>
   <dd><dl>
     <dt><a href="reference/celery.timer.html#celery.timer.TimeoutTimer.tick">(celery.timer.TimeoutTimer method)</a></dt>

index.html

@@ -53,17 +53,23 @@
 <li class="toctree-l2"><a class="reference external" href="introduction.html#introduction">Introduction</a></li>
 <li class="toctree-l2"><a class="reference external" href="introduction.html#features">Features</a></li>
 <li class="toctree-l2"><a class="reference external" href="introduction.html#api-reference-documentation">API Reference Documentation</a></li>
-<li class="toctree-l2"><a class="reference external" href="introduction.html#installation">Installation</a></li>
+<li class="toctree-l2"><a class="reference external" href="introduction.html#installation">Installation</a><ul>
+<li class="toctree-l3"><a class="reference external" href="introduction.html#downloading-and-installing-from-source">Downloading and installing from source</a></li>
+<li class="toctree-l3"><a class="reference external" href="introduction.html#using-the-development-version">Using the development version</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference external" href="introduction.html#usage">Usage</a><ul>
 <li class="toctree-l3"><a class="reference external" href="introduction.html#installing-rabbitmq">Installing RabbitMQ</a></li>
 <li class="toctree-l3"><a class="reference external" href="introduction.html#setting-up-rabbitmq">Setting up RabbitMQ</a></li>
 <li class="toctree-l3"><a class="reference external" href="introduction.html#configuring-your-django-project-to-use-celery">Configuring your Django project to use Celery</a></li>
-<li class="toctree-l3"><a class="reference external" href="introduction.html#running-the-celery-worker-daemon">Running the celery worker daemon</a></li>
+<li class="toctree-l3"><a class="reference external" href="introduction.html#running-the-celery-worker-server">Running the celery worker server</a></li>
 <li class="toctree-l3"><a class="reference external" href="introduction.html#defining-and-executing-tasks">Defining and executing tasks</a></li>
 <li class="toctree-l3"><a class="reference external" href="introduction.html#auto-discovery-of-tasks">Auto-discovery of tasks</a></li>
 <li class="toctree-l3"><a class="reference external" href="introduction.html#periodic-tasks">Periodic Tasks</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference external" href="introduction.html#bug-tracker">Bug tracker</a></li>
+<li class="toctree-l2"><a class="reference external" href="introduction.html#contributing">Contributing</a></li>
 <li class="toctree-l2"><a class="reference external" href="introduction.html#license">License</a></li>
 </ul>
 </li>

introduction.html

@@ -116,12 +116,24 @@ or from source.</p>
 <p>To install using <tt class="docutils literal"><span class="pre">easy_install</span></tt>,:</p>
 <div class="highlight-python"><pre>$ easy_install celery</pre>
 </div>
-<p>If you have downloaded a source tarball you can install it
-by doing the following,:</p>
-<div class="highlight-python"><pre>$ python setup.py build
+<div class="section" id="downloading-and-installing-from-source">
+<h3>Downloading and installing from source<a class="headerlink" href="#downloading-and-installing-from-source" title="Permalink to this headline">¶</a></h3>
+<p>Download the latest version of <tt class="docutils literal"><span class="pre">celery</span></tt> from
+<a class="reference external" href="http://pypi.python.org/pypi/celery/">http://pypi.python.org/pypi/celery/</a></p>
+<p>You can install it by doing the following,:</p>
+<div class="highlight-python"><pre>$ tar xvfz celery-0.0.0.tar.gz
+$ cd celery-0.0.0
+$ python setup.py build
 # python setup.py install # as root</pre>
 </div>
 </div>
+<div class="section" id="using-the-development-version">
+<h3>Using the development version<a class="headerlink" href="#using-the-development-version" title="Permalink to this headline">¶</a></h3>
+<p>You can clone the repository by doing the following:</p>
+<div class="highlight-python"><pre>$ git clone git@github.com:ask/celery.git celery</pre>
+</div>
+</div>
+</div>
 <div class="section" id="usage">
 <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="installing-rabbitmq">
@@ -173,17 +185,17 @@ available, please consult the <a class="reference external" href="http://ask.git
 <tt class="docutils literal"><span class="pre">celeryd</span></tt> will only be able to process one task at a time, this is
 because SQLite doesn&#8217;t allow concurrent writes.</p>
 </div>
-<div class="section" id="running-the-celery-worker-daemon">
-<h3>Running the celery worker daemon<a class="headerlink" href="#running-the-celery-worker-daemon" title="Permalink to this headline">¶</a></h3>
-<p>To test this we&#8217;ll be running the worker daemon in the foreground, so we can
+<div class="section" id="running-the-celery-worker-server">
+<h3>Running the celery worker server<a class="headerlink" href="#running-the-celery-worker-server" title="Permalink to this headline">¶</a></h3>
+<p>To test this we&#8217;ll be running the worker server in the foreground, so we can
 see what&#8217;s going on without consulting the logfile:</p>
 <div class="highlight-python"><pre>$ python manage.py celeryd</pre>
 </div>
 <p>However, in production you&#8217;ll probably want to run the worker in the
 background as a daemon instead:</p>
-<div class="highlight-python"><pre>$ python manage.py celeryd --daemon</pre>
+<div class="highlight-python"><pre>$ python manage.py celeryd --detach</pre>
 </div>
-<p>For help on command line arguments to the worker daemon, you can execute the
+<p>For help on command line arguments to the worker server, you can execute the
 help command:</p>
 <div class="highlight-python"><pre>$ python manage.py help celeryd</pre>
 </div>
@@ -195,7 +207,7 @@ be defined in the python shell or ipython/bpython. This is because the celery
 worker server needs access to the task function to be able to run it.
 So while it looks like we use the python shell to define the tasks in these
 examples, you can&#8217;t do it this way. Put them in the <tt class="docutils literal"><span class="pre">tasks</span></tt> module of your
-Django application. The worker daemon will automatically load any <tt class="docutils literal"><span class="pre">tasks.py</span></tt>
+Django application. The worker server will automatically load any <tt class="docutils literal"><span class="pre">tasks.py</span></tt>
 file for all of the applications listed in <tt class="docutils literal"><span class="pre">settings.INSTALLED_APPS</span></tt>.
 Executing tasks using <tt class="docutils literal"><span class="pre">delay</span></tt> and <tt class="docutils literal"><span class="pre">apply_async</span></tt> can be done from the
 python shell, but keep in mind that since arguments are pickled, you can&#8217;t
@@ -274,6 +286,18 @@ Here&#8217;s an example of a periodic task:</p>
 really make sense.</p>
 </div>
 </div>
+<div class="section" id="bug-tracker">
+<h2>Bug tracker<a class="headerlink" href="#bug-tracker" title="Permalink to this headline">¶</a></h2>
+<p>If you have any suggestions, bug reports or annoyances please report them
+to our issue tracker at <a class="reference external" href="http://github.com/ask/celery/issues/">http://github.com/ask/celery/issues/</a></p>
+</div>
+<div class="section" id="contributing">
+<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
+<p>Development of <tt class="docutils literal"><span class="pre">celery</span></tt> happens at Github: <a class="reference external" href="http://github.com/ask/celery">http://github.com/ask/celery</a></p>
+<p>You are highly encouraged to participate in the development
+of <tt class="docutils literal"><span class="pre">celery</span></tt>. If you don&#8217;t like Github (for some reason) you&#8217;re welcome
+to send regular patches.</p>
+</div>
 <div class="section" id="license">
 <h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
 <p>This software is licensed under the <tt class="docutils literal"><span class="pre">New</span> <span class="pre">BSD</span> <span class="pre">License</span></tt>. See the <tt class="docutils literal"><span class="pre">LICENSE</span></tt>
@@ -295,6 +319,8 @@ file in the top distribution directory for the full license text.</p>
 <li class="toctree-l2"><a class="reference external" href="#api-reference-documentation">API Reference Documentation</a></li>
 <li class="toctree-l2"><a class="reference external" href="#installation">Installation</a></li>
 <li class="toctree-l2"><a class="reference external" href="#usage">Usage</a></li>
+<li class="toctree-l2"><a class="reference external" href="#bug-tracker">Bug tracker</a></li>
+<li class="toctree-l2"><a class="reference external" href="#contributing">Contributing</a></li>
 <li class="toctree-l2"><a class="reference external" href="#license">License</a></li>
 </ul>
 </li>

objects.inv

@@ -233,6 +233,7 @@ celery.conf.DAEMON_CONCURRENCY data reference/celery.conf.html
 celery.worker.WorkController.logger attribute reference/celery.worker.html
 celery.registry.TaskRegistry.get_all method reference/celery.registry.html
 celery.backends.tyrant.Backend.store_result method reference/celery.backends.tyrant.html
+celery.pool.TaskPool.terminate method reference/celery.pool.html
 celery.timer.TimeoutTimer.tick method reference/celery.timer.html
 TASK_STATUS_PENDING data reference/celery.models.html
 celery.registry.TaskRegistry.get_task method reference/celery.registry.html

reference/celery.pool.html

@@ -180,6 +180,11 @@ been collected.</dd></dl>
 for processing tasks.</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="celery.pool.TaskPool.terminate">
+<tt class="descname">terminate</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.pool.TaskPool.terminate" title="Permalink to this definition">¶</a></dt>
+<dd>Terminate the pool.</dd></dl>
+
 <dl class="method">
 <dt id="celery.pool.TaskPool.wait_for_result">
 <tt class="descname">wait_for_result</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.pool.TaskPool.wait_for_result" title="Permalink to this definition">¶</a></dt>

reference/celery.registry.html

@@ -108,12 +108,12 @@ exception </em><tt class="descclassname">TaskRegistry.</tt><tt class="descname">
 
 <dl class="method">
 <dt id="celery.registry.TaskRegistry.get_task">
-<tt class="descclassname">TaskRegistry.</tt><tt class="descname">get_task</tt><big>(</big><em>task_name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.get_task" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">TaskRegistry.</tt><tt class="descname">get_task</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.get_task" title="Permalink to this definition">¶</a></dt>
 <dd>Get task by name.</dd></dl>
 
 <dl class="method">
 <dt id="celery.registry.TaskRegistry.register">
-<tt class="descclassname">TaskRegistry.</tt><tt class="descname">register</tt><big>(</big><em>task</em>, <em>task_name=None</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.register" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">TaskRegistry.</tt><tt class="descname">register</tt><big>(</big><em>task</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.register" title="Permalink to this definition">¶</a></dt>
 <dd><p>Register a task in the task registry.</p>
 <p>Task can either be a regular function, or a class inheriting
 from <a title="celery.task.Task" class="reference external" href="celery.task.html#celery.task.Task"><tt class="xref docutils literal"><span class="pre">celery.task.Task</span></tt></a>.</p>
@@ -121,7 +121,7 @@ from <a title="celery.task.Task" class="reference external" href="celery.task.ht
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>task_name</em> &#8211; By default the <tt class="xref docutils literal"><span class="pre">Task.name</span></tt> attribute on the
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>name</em> &#8211; By default the <tt class="xref docutils literal"><span class="pre">Task.name</span></tt> attribute on the
 task is used as the name of the task, but you can override it
 using this option.</td>
 </tr>
@@ -134,14 +134,21 @@ using this option.</td>
 
 <dl class="method">
 <dt id="celery.registry.TaskRegistry.unregister">
-<tt class="descclassname">TaskRegistry.</tt><tt class="descname">unregister</tt><big>(</big><em>task_name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.unregister" title="Permalink to this definition">¶</a></dt>
+<tt class="descclassname">TaskRegistry.</tt><tt class="descname">unregister</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.unregister" title="Permalink to this definition">¶</a></dt>
 <dd><p>Unregister task by name.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>task_name</em> &#8211; name of the task to unregister.</td>
+<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>name</em> &#8211; name of the task to unregister, or a</td>
 </tr>
+</tbody>
+</table>
+<p><a title="celery.task.Task" class="reference external" href="celery.task.html#celery.task.Task"><tt class="xref docutils literal"><span class="pre">celery.task.Task</span></tt></a> class with a valid <tt class="docutils literal"><span class="pre">name</span></tt> attribute.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
 <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.registry.NotRegistered" class="reference internal" href="#celery.registry.NotRegistered">NotRegistered</a>:</th></tr>
 <tr><td>&nbsp;</td><td class="field-body">if the task has not been registered.</td>
 </tr>

reference/celery.worker.html

@@ -61,7 +61,7 @@ exception </em><tt class="descclassname">celery.worker.</tt><tt class="descname"
 <dl class="class">
 <dt id="celery.worker.PeriodicWorkController">
 <em class="property">
-class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">PeriodicWorkController</tt><big>(</big><em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>verbose=None</em><big>)</big><a class="headerlink" href="#celery.worker.PeriodicWorkController" title="Permalink to this definition">¶</a></dt>
+class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">PeriodicWorkController</tt><a class="headerlink" href="#celery.worker.PeriodicWorkController" title="Permalink to this definition">¶</a></dt>
 <dd><p>A thread that continuously checks if there are
 :class:<a href="#id1"><span class="problematic" id="id2">`</span></a>celery.task.PeriodicTask`s waiting for execution, and executes
 them.</p>

reference/index.html

@@ -56,7 +56,7 @@
 <tbody valign="top">
 <tr class="field"><th class="field-name">Release:</th><td class="field-body">0.3</td>
 </tr>
-<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 10, 2009</td>
+<tr class="field"><th class="field-name">Date:</th><td class="field-body">June 13, 2009</td>
 </tr>
 </tbody>
 </table>

sources/introduction.txt

@@ -81,12 +81,28 @@ To install using ``easy_install``,::
 
     $ easy_install celery
 
-If you have downloaded a source tarball you can install it
-by doing the following,::
+Downloading and installing from source
+--------------------------------------
 
+Download the latest version of ``celery`` from
+http://pypi.python.org/pypi/celery/
+
+You can install it by doing the following,::
+
+    $ tar xvfz celery-0.0.0.tar.gz
+    $ cd celery-0.0.0
     $ python setup.py build
     # python setup.py install # as root
 
+Using the development version
+------------------------------
+
+
+You can clone the repository by doing the following::
+
+    $ git clone git@github.com:ask/celery.git celery
+
+
 Usage
 =====
 
@@ -146,10 +162,10 @@ available, please consult the `API Reference`_
 ``celeryd`` will only be able to process one task at a time, this is
 because SQLite doesn't allow concurrent writes.
 
-Running the celery worker daemon
+Running the celery worker server
 --------------------------------
 
-To test this we'll be running the worker daemon in the foreground, so we can
+To test this we'll be running the worker server in the foreground, so we can
 see what's going on without consulting the logfile::
 
     $ python manage.py celeryd
@@ -158,10 +174,10 @@ see what's going on without consulting the logfile::
 However, in production you'll probably want to run the worker in the
 background as a daemon instead::
 
-    $ python manage.py celeryd --daemon
+    $ python manage.py celeryd --detach
 
 
-For help on command line arguments to the worker daemon, you can execute the
+For help on command line arguments to the worker server, you can execute the
 help command::
 
     $ python manage.py help celeryd
@@ -175,7 +191,7 @@ be defined in the python shell or ipython/bpython. This is because the celery
 worker server needs access to the task function to be able to run it.
 So while it looks like we use the python shell to define the tasks in these
 examples, you can't do it this way. Put them in the ``tasks`` module of your
-Django application. The worker daemon will automatically load any ``tasks.py``
+Django application. The worker server will automatically load any ``tasks.py``
 file for all of the applications listed in ``settings.INSTALLED_APPS``.
 Executing tasks using ``delay`` and ``apply_async`` can be done from the
 python shell, but keep in mind that since arguments are pickled, you can't
@@ -261,6 +277,22 @@ Here's an example of a periodic task:
 **Note:** Periodic tasks does not support arguments, as this doesn't
 really make sense.
 
+
+Bug tracker
+===========
+
+If you have any suggestions, bug reports or annoyances please report them
+to our issue tracker at http://github.com/ask/celery/issues/
+
+Contributing
+============
+
+Development of ``celery`` happens at Github: http://github.com/ask/celery
+
+You are highly encouraged to participate in the development
+of ``celery``. If you don't like Github (for some reason) you're welcome
+to send regular patches.
+
 License
 =======