mattmakai / fullstackpython.com

Full Stack Python source with Pelican, Bootstrap and Markdown.
https://www.fullstackpython.com/
MIT License
2.87k stars 628 forks source link

Description of "Huey" task queue is inaccurate #80

Open coleifer opened 8 years ago

coleifer commented 8 years ago

On the task queues page, the huey library is not described accurately.

I'm the author of huey, and in the project documentation I give the following description of huey:

a lightweight alternative.

  • written in python
  • only dependency is the Python Redis client

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
  • retry tasks that fail automatically
  • task result storage

I'd suggest changing the description of "huey" to read something like:

Huey is a Redis-based task queue that aims to provide a simple, yet flexible framework for executing tasks. Huey supports task scheduling, crontab-like repeating tasks, result storage and automatic retry in the event of failure.

What do you think?

mattmakai commented 8 years ago

Hey Charles, definitely cannot argue with the project's developer on the description :)

The new description looks good, I'm updating the page now and it'll be live soon as I push this. A few of quick questions:

  1. is Redis the only broker it's designed to work with?
  2. is it true that it was renamed from Invoker to Huey? might be good if I continue to provide context for readers
  3. do you have links to tutorials or source code that you feel is particularly good for developers to follow as they set up Huey?

thanks!

coleifer commented 8 years ago

Thanks so much for the quick reply!!

Redis is currently the only backend, but it supports a pretty simple API and other backends could be added.

It is not quite correct. It was called "Cue" originally but nobody ever used it back then. Really everyone probably knows it as "huey".

I think the best source is going to be the "getting started guide": http://huey.readthedocs.org/en/latest/getting-started.html

thanks again for your awesome resource, I appreciate you including my project.