Metadata-Version: 1.1
Name: dj-pq
Version: 1.4.2
Summary: ``pq`` wrapper for django
Home-page: https://github.com/jeanphix/dj-pq/
Author: jean-philippe serafin
Author-email: serafinjp@gmail.com
License: BSD License
Description: dj-pq
        =====
        
        `pq <https://github.com/malthe/pq>`_ wrapper for django.
        
        .. image:: https://travis-ci.org/jeanphix/dj-pq.svg?branch=master
            :target: https://travis-ci.org/jeanphix/dj-pq
        
        
        Installation
        ------------
        
        
        .. code-block:: bash
        
            pip install dj-pq
        
        
        Configuration
        -------------
        
        Add ``dj_pq`` to your ``INSTALLED_APPS``:
        
        .. code-block:: python
        
            INSTALLED_APPS += [
                'dj_pq',
            ]
        
        
        Apply migrations::
        
            ./manage.py migrate
        
        
        Usage
        -----
        
        ``dj-pq`` exposes the `pq tasks API <https://github.com/malthe/pq/#tasks>`_.
        
        .. code-block:: python
        
            from dj_pq import get_queue
        
            queue = get_queue('notifications')
        
            @queue.task()
            def notify(user_id):
                User.objects.get(id=user_id).notify()
        
            notify(42)
        
        
        Optionally a ``Queue`` can be bound to a specific database connection:
        
        .. code-block:: python
        
            queue = get_queue('notifications', 'another_connection')
        
        
        A ``worker`` command allows to start a worker for a given queue::
        
            ./manage.py worker notifications
        
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Systems Administration
