skip to navigation
skip to content

huey 1.9.0

huey, a little task queue

huey - a little task queue

.. image::

a lightweight alternative.

* written in python (2.7+, 3.4+)
* optional dependency on the Python Redis client


* multi-process, multi-thread or greenlet task execution models
* schedule tasks to execute at a given time, or after a given delay
* schedule recurring tasks, like a crontab
* retry tasks that fail automatically
* task result storage
* task locking
* task pipelines and chains

.. image::

.. image::

Huey's API

.. code-block:: python

from huey import RedisHuey, crontab

huey = RedisHuey('my-app', host='')

def add_numbers(a, b):
return a + b

@huey.periodic_task(crontab(minute='0', hour='3'))
def nightly_backup():

To run the consumer with 4 worker processes:

.. code-block:: console

$ my_app.huey -k process -w 4

To enqueue a task to add two numbers and print the result:

.. code-block:: python

res = add_numbers(1, 2) # Enqueues task.
print(res.get()) # Prints "3".

To schedule two numbers to be added in 10 seconds:

.. code-block:: python

res = add_numbers.schedule(args=(1, 2), delay=10)

# Attempt to get result without blocking.
print(res.get(False)) # returns None.

# Block until result is ready and print.
print(res.get()) # after 10 seconds, prints "3".


To use Huey with Redis (**recommended**):

.. code-block:: python

from huey import RedisHuey

huey = RedisHuey()

To use Huey with SQLite (`docs <http:"" en="" latest="" contrib.html#sqlite-storage="">`_):

.. code-block:: python

from huey.contrib.sqlitedb import SqliteHuey

huey = SqliteHuey('my-app-queue.db')

To run Huey within the parent process using background greenlets (`docs <http:"" en="" latest="" contrib.html#mini-huey="">`_):

.. code-block:: python

from huey.contrib.minimal import MiniHuey

huey = MiniHuey()
huey.start() # Spawns scheduler background thread and returns immediately.

To run Huey with a simple Python broker (**should not be used in production**),
install [simpledb]( and run:

.. code-block:: python

from huey.contrib.simple_storage import SimpleHuey

huey = SimpleHuey()

# Be sure to run the Python broker process, e.g.:
# $ python # Starts Python broker.


`See Huey documentation <https:""/>`_.

Project page

`See source code and issue tracker on Github <https:"" coleifer="" huey=""/>`_.

Huey is named in honor of my cat:

.. image::

File Type Py Version Uploaded on Size
huey-1.9.0.tar.gz (md5) Source 2018-03-12 301KB