Skip to main content
https://media.charlesleifer.com/blog/photos/huey3-logo.png

a lightweight alternative.

huey is:

  • a task queue

  • written in python

  • clean and simple API

huey has:

  • support for redis (or valkey/redict), postgres, sqlite, file-system, or in-memory storage

  • zero dependencies (redis-py required to use redis-like brokers, psycopg for postgres).

  • example code.

  • django integration (native or via django.tasks) with admin integration for visibility and management.

  • documentation.

huey supports:

  • 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

  • automatically retry tasks that fail

  • task prioritization

  • task result storage

  • task expiration

  • task locking, rate-limits and timeouts

  • task pipelines and chains

  • groups (fan-out), chords (map / reduce)

https://i.imgur.com/2EpRs.jpg

At a glance

from huey import RedisHuey, crontab

# Or PostgresHuey, SqliteHuey, FileHuey, etc...
huey = RedisHuey('my-app', host='redis.myapp.com')

@huey.task()
def add_numbers(a, b):
    return a + b

@huey.task(retries=2, retry_delay=60)
def flaky_task(url):
    # This task might fail, in which case it will be retried up to 2 times
    # with a delay of 60s between retries.
    return this_might_fail(url)

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

Calling a task-decorated function will enqueue the function call for execution by the consumer. A special result handle is returned immediately, which can be used to fetch the result once the task is finished:

>>> from demo import add_numbers
>>> res = add_numbers(1, 2)
>>> res
<Result: task 6b6f36fc-da0d-4069-b46c-c0d4ccff1df6>

>>> res()
3

Tasks can be scheduled to run in the future:

>>> res = add_numbers.schedule((2, 3), delay=10)  # Will be run in ~10s.
>>> res(blocking=True)  # Will block until task finishes, in ~10s.
5

For much more, check out the guide or take a look at the example code.

Running the consumer

Run the consumer with four worker processes:

$ huey_consumer my_app.huey -k process -w 4

To run the consumer with a single worker thread (default):

$ huey_consumer my_app.huey

If your work-loads are mostly IO-bound, you can run the consumer with threads or greenlets instead. Because greenlets are so lightweight, you can run quite a few of them efficiently:

$ huey_consumer my_app.huey -k greenlet -w 32

Storage

Huey’s design and feature-set were informed by the capabilities of the Redis database. Redis is a fantastic fit for a lightweight task queueing library like Huey: it’s self-contained, versatile, and can be a multi-purpose solution for other web-application tasks like caching, event publishing, analytics, rate-limiting, and more.

Although Huey was designed with Redis in mind, the storage system implements a simple API and many other tools could be used instead of Redis if that’s your preference.

Huey comes with builtin support for Redis, Postgres, Sqlite, File-system, and in-memory storage.

Frameworks

Huey provides Django integration either natively or via django.tasks. Huey also provides an optional admin integration for Django:

https://huey.readthedocs.io/en/latest/_images/django-admin.png

Huey also provides flask-peewee admin integration based on the same underlying stat-tracking system:

https://huey.readthedocs.io/en/latest/_images/flask-admin-panel.png

Other frameworks can use the stats extension to collect and display this information.

Documentation

See Huey documentation.

Project page

See source code and issue tracker on Github.

Huey is named in honor of my cat:

https://m.charlesleifer.com/t/800x-/blog/photos/p1473037658.76.jpg?key=mD9_qMaKBAuGPi95KzXYqg

Metadata

Release files for huey 3.5.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for huey 3.5.3
File Size Uploaded Provenance
huey-3.5.3.tar.gz 625.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for huey 3.5.3
File Interpreter ABI Platform
huey-3.5.3-py3-none-any.whl Python 3 none any Details

Total release size: 765.5 kB

Release files / huey-3.5.3.tar.gz

Download URL huey-3.5.3.tar.gz
Size 625.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3d9e8fe95638bde843fbcfe38c063d906afa0d4b0cf94955a24c0f90eb09bb44
BLAKE2b-256 checksum
How to use checksums
c734a5193a2658b0e21a787bf23c4f58ed95238c9882371e26e4d169059d91fc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / huey-3.5.3-py3-none-any.whl

Download URL huey-3.5.3-py3-none-any.whl
Size 139.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
30cbf102f2074570709cf5a5f8e4a1826cf1fbb55d7fcffda1272a0cfa74f55d
BLAKE2b-256 checksum
How to use checksums
ce2cbce2ca816fa58424d56792b520336651a0f17c13739d88ddfa8385199718
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for huey 3.5.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.5.3 This release

2 release files No provenance

0.4.4

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page