Metadata-Version: 2.1
Name: django-huey
Version: 0.1.1
Summary: An extension for django and huey that supports multi queue management
Home-page: https://github.com/gaiacoop/django-huey
Author: GAIA - Cooperativa de desarrollo de software
Author-email: contacto@gaiacoop.tech
License: UNKNOWN
Description: ![Version](https://img.shields.io/badge/version-0.1.1-informational.svg)
        
        # django-huey
        
        This package is an extension of huey contrib djhuey package that allows users to manage multiple queues.
        
        ## Installation
        
        Using pip package manager run:
        ```
        # pip install Django  if not installed
        # pip install huey    if not installed
        pip install django-huey
        ```
        
        Note: use a virtualenv to isolate your dependencies.
        Note 2: *django* and *huey* must be installed.
        
        Then, in your **settings.py** file add django_huey to the INSTALLED_APPS:
        ```python
        INSTALLED_APPS = [
        	...
            'django_huey',
        ]
        ```
        
        ## Configuration
        In **settings.py** you must add the HUEYS setting:
        ```python
        HUEYS = {
            'first': {#this name will be used in decorators below
                'huey_class': 'huey.RedisHuey',  
                'name': 'first_tasks',  
                'consumer': {
                    'workers': 2,
                    'worker_type': 'thread',
                },
            },
            'emails': {#this name will be used in decorators below
                'huey_class': 'huey.RedisHuey',  
                'name': 'emails_tasks',  
                'consumer': {
                    'workers': 5,
                    'worker_type': 'thread',
                },
            }
        }
        ```
        **Note:** This setting is incompatible with HUEY setting.
        
        ## Usage
        Now you will be able to run multiple queues using:
        ```
        python manage.py run_djangohuey --queue first
        python manage.py run_djangohuey --queue emails
        ```
        Each queue must be run in a different terminal.
        
        ## Configuring tasks
        You can use usual *huey* decorators to register tasks, but they must be imported from django_huey as shown below:
        
        ```python
        from django_huey import db_task, task
        
        @db_task(queue='first')
        	# perform some db task
        
        @task(queue='emails')
        	# send some emails
        ```
        
        All the args and kwargs defined in huey decorators should work in the same way, if not, let us know.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
