Browse Source

Setuptools extras replaces the bundles concept

Ask Solem 11 years ago
parent
commit
d1fe473d03

+ 28 - 20
README.rst

@@ -4,11 +4,7 @@
 
 .. image:: http://cloud.github.com/downloads/celery/celery/celery_128.png
 
-<<<<<<< HEAD
-:Version: 3.1.0rc4 (Cipater)
-=======
 :Version: 3.0.23 (Chiastic Slide)
->>>>>>> 3.0
 :Web: http://celeryproject.org/
 :Download: http://pypi.python.org/pypi/celery/
 :Source: http://github.com/celery/celery/
@@ -233,28 +229,40 @@ Bundles
 Celery also defines a group of bundles that can be used
 to install Celery and the dependencies for a given feature.
 
+You can specify these in your requirements or on the ``pip`` comand-line
+by using brackets.  Multiple bundles can be specified by separating them by
+commas.
+::
+
+    $ pip install celery[librabbitmq]
+
+    $ pip install celery[librabbitmq,redis]
+
 The following bundles are available:
 
-:`celery-with-redis`_:
-    for using Redis as a broker.
+:celery[librabbitmq]:
+    for using the librabbitmq C library.
+
+:celery[redis]:
+    for using Redis as a message transport or as a result backend.
+
+:celery[mongodb]:
+    for using MongoDB as a message transport, or as a result backend.
+
+:celery[couchdb]:
+    for using CouchDB as a message transport.
 
-:`celery-with-mongodb`_:
-    for using MongoDB as a broker.
+:celery[beanstalk]:
+    for using Beanstalk as a message transport.
 
-:`django-celery-with-redis`_:
-    for Django, and using Redis as a broker.
+:celery[zookeeper]:
+    for using Zookeeper as a message transport.
 
-:`django-celery-with-mongodb`_:
-    for Django, and using MongoDB as a broker.
+:celery[zeromq]:
+    for using ZeroMQ as a message transport.
 
-.. _`celery-with-redis`:
-    http://pypi.python.org/pypi/celery-with-redis/
-.. _`celery-with-mongodb`:
-    http://pypi.python.org/pypi/celery-with-mongdb/
-.. _`django-celery-with-redis`:
-    http://pypi.python.org/pypi/django-celery-with-redis/
-.. _`django-celery-with-mongodb`:
-    http://pypi.python.org/pypi/django-celery-with-mongdb/
+:celery[sqlalchemy]:
+    for using SQLAlchemy as a message transport, or as a result backend.
 
 .. _celery-installing-from-source:
 

+ 0 - 66
celery/contrib/bundles.py

@@ -1,66 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-    celery.contrib.bundles
-    ~~~~~~~~~~~~~~~~~~~~~~
-
-    Celery PyPI Bundles.
-
-"""
-from __future__ import absolute_import
-
-from celery import VERSION
-from bundle.extensions import Dist
-
-__all__ = ['bundles']
-
-defaults = {'author': 'Celery Project',
-            'author_email': 'bundles@celeryproject.org',
-            'url': 'http://celeryproject.org',
-            'license': 'BSD'}
-celery = Dist('celery', VERSION, **defaults)
-django_celery = Dist('django-celery', VERSION, **defaults)
-flask_celery = Dist('Flask-Celery', VERSION, **defaults)
-
-bundles = [
-    celery.Bundle(
-        'celery-with-redis',
-        'Bundle installing the dependencies for Celery and Redis',
-        requires=['redis>=2.4.4'],
-    ),
-    celery.Bundle(
-        'celery-with-mongodb',
-        'Bundle installing the dependencies for Celery and MongoDB',
-        requires=['pymongo'],
-    ),
-    celery.Bundle(
-        'celery-with-couchdb',
-        'Bundle installing the dependencies for Celery and CouchDB',
-        requires=['couchdb'],
-    ),
-    celery.Bundle(
-        'celery-with-beanstalk',
-        'Bundle installing the dependencies for Celery and Beanstalk',
-        requires=['beanstalkc'],
-    ),
-
-    django_celery.Bundle(
-        'django-celery-with-redis',
-        'Bundle installing the dependencies for Django-Celery and Redis',
-        requires=['redis>=2.4.4'],
-    ),
-    django_celery.Bundle(
-        'django-celery-with-mongodb',
-        'Bundle installing the dependencies for Django-Celery and MongoDB',
-        requires=['pymongo'],
-    ),
-    django_celery.Bundle(
-        'django-celery-with-couchdb',
-        'Bundle installing the dependencies for Django-Celery and CouchDB',
-        requires=['couchdb'],
-    ),
-    django_celery.Bundle(
-        'django-celery-with-beanstalk',
-        'Bundle installing the dependencies for Django-Celery and Beanstalk',
-        requires=['beanstalkc'],
-    ),
-]

+ 0 - 17
docs/contributing.rst

@@ -906,20 +906,3 @@ following:
     for series 2.4.
 
 * Also add the previous version under the "versions" tab.
-
-
-Updating bundles
-----------------
-
-First you need to make sure the bundle entrypoints have been installed,
-but either running `develop`, or `install`::
-
-    $ python setup.py develop
-
-Then make sure that you have your PyPI credentials stored in
-:file:`~/.pypirc`, and execute the command::
-
-    $ python setup.py upload_bundles
-
-If you broke something and need to update new versions of the bundles,
-then you can use ``upload_bundles_fix``.

+ 2 - 8
docs/getting-started/brokers/beanstalk.rst

@@ -11,17 +11,11 @@ Installation
 
 For the Beanstalk support you have to install additional dependencies.
 You can install both Celery and these dependencies in one go using
-either the `celery-with-beanstalk`_, or the `django-celery-with-beanstalk`
-bundles:
+the ``celery[beanstalk]`` :ref:`bundle <bundles>`:
 
 .. code-block:: bash
 
-    $ pip install -U celery-with-beanstalk
-
-.. _`celery-with-beanstalk`:
-    http://pypi.python.org/pypi/celery-with-beanstalk
-.. _`django-celery-with-beanstalk`:
-    http://pypi.python.org/pypi/django-celery-with-beanstalk
+    $ pip install -U celery[beanstalk]
 
 .. _broker-beanstalk-configuration:
 

+ 2 - 7
docs/getting-started/brokers/couchdb.rst

@@ -11,16 +11,11 @@ Installation
 
 For the CouchDB support you have to install additional dependencies.
 You can install both Celery and these dependencies in one go using
-either the `celery-with-couchdb`_, or the `django-celery-with-couchdb` bundles:
+the ``celery[couchdb]`` :ref:`bundle <bundles>`:
 
 .. code-block:: bash
 
-    $ pip install -U celery-with-couchdb
-
-.. _`celery-with-couchdb`:
-    http://pypi.python.org/pypi/celery-with-couchdb
-.. _`django-celery-with-couchdb`:
-    http://pypi.python.org/pypi/django-celery-with-couchdb
+    $ pip install -U celery[couchdb]
 
 .. _broker-couchdb-configuration:
 

+ 2 - 7
docs/getting-started/brokers/mongodb.rst

@@ -11,16 +11,11 @@ Installation
 
 For the MongoDB support you have to install additional dependencies.
 You can install both Celery and these dependencies in one go using
-either the `celery-with-mongodb`_, or the `django-celery-with-mongodb` bundles:
+the ``celery[mongodb]`` :ref:`bundle <bundles>`:
 
 .. code-block:: bash
 
-    $ pip install -U celery-with-mongodb
-
-.. _`celery-with-mongodb`:
-    http://pypi.python.org/pypi/celery-with-mongodb
-.. _`django-celery-with-mongodb`:
-    http://pypi.python.org/pypi/django-celery-with-mongodb
+    $ pip install -U celery[mongodb]
 
 .. _broker-mongodb-configuration:
 

+ 2 - 7
docs/getting-started/brokers/redis.rst

@@ -11,16 +11,11 @@ Installation
 
 For the Redis support you have to install additional dependencies.
 You can install both Celery and these dependencies in one go using
-either the `celery-with-redis`_, or the `django-celery-with-redis` bundles:
+the ``celery[redis]`` :ref:`bundle <bundles>`:
 
 .. code-block:: bash
 
-    $ pip install -U celery-with-redis
-
-.. _`celery-with-redis`:
-    http://pypi.python.org/pypi/celery-with-redis
-.. _`django-celery-with-redis`:
-    http://pypi.python.org/pypi/django-celery-with-redis
+    $ pip install -U celery[redis]
 
 .. _broker-redis-configuration:
 

+ 29 - 16
docs/includes/installation.txt

@@ -22,28 +22,41 @@ Bundles
 Celery also defines a group of bundles that can be used
 to install Celery and the dependencies for a given feature.
 
+You can specify these in your requirements or on the ``pip`` comand-line
+by using brackets.  Multiple bundles can be specified by separating them by
+commas.
+
+.. code-block:: bash
+
+    $ pip install celery[librabbitmq]
+
+    $ pip install celery[librabbitmq,redis]
+
 The following bundles are available:
 
-:`celery-with-redis`_:
-    for using Redis as a broker.
+:celery[librabbitmq]:
+    for using the librabbitmq C library.
+
+:celery[redis]:
+    for using Redis as a message transport or as a result backend.
+
+:celery[mongodb]:
+    for using MongoDB as a message transport, or as a result backend.
+
+:celery[couchdb]:
+    for using CouchDB as a message transport.
 
-:`celery-with-mongodb`_:
-    for using MongoDB as a broker.
+:celery[beanstalk]:
+    for using Beanstalk as a message transport.
 
-:`django-celery-with-redis`_:
-    for Django, and using Redis as a broker.
+:celery[zookeeper]:
+    for using Zookeeper as a message transport.
 
-:`django-celery-with-mongodb`_:
-    for Django, and using MongoDB as a broker.
+:celery[zeromq]:
+    for using ZeroMQ as a message transport.
 
-.. _`celery-with-redis`:
-    http://pypi.python.org/pypi/celery-with-redis/
-.. _`celery-with-mongodb`:
-    http://pypi.python.org/pypi/celery-with-mongdb/
-.. _`django-celery-with-redis`:
-    http://pypi.python.org/pypi/django-celery-with-redis/
-.. _`django-celery-with-mongodb`:
-    http://pypi.python.org/pypi/django-celery-with-mongdb/
+:celery[sqlalchemy]:
+    for using SQLAlchemy as a message transport, or as a result backend.
 
 .. _celery-installing-from-source:
 

+ 0 - 1
extra/release/doc4allmods

@@ -9,7 +9,6 @@ SKIP_FILES="celery.five.rst
             celery.bin.rst
             celery.bin.celeryd_detach.rst
             celery.contrib.rst
-            celery.contrib.bundles.rst
             celery.fixups.rst
             celery.fixups.django.rst
             celery.local.rst

+ 0 - 3
setup.py

@@ -181,9 +181,6 @@ if CELERY_COMPAT_PROGRAMS:
         'celeryd-multi = celery.__main__:_compat_multi',
     ])
 
-# bundles: Only relevant for Celery developers.
-entrypoints['bundle.bundles'] = ['celery = celery.contrib.bundles:bundles']
-
 if is_setuptools:
     extras = lambda *p: reqs('extras', *p)
     extras_require = extra['extras_require'] = {