.. image:: https://img.shields.io/pypi/pyversions/celery-redbeat.svg :target: https://pypi.python.org/pypi/celery-redbeat :alt: Python Versions
.. image:: https://img.shields.io/pypi/v/celery-redbeat.svg :target: https://pypi.python.org/pypi/celery-redbeat :alt: PyPI Package
.. image:: https://github.com/sibson/redbeat/workflows/RedBeat%20CI/badge.svg :target: https://github.com/sibson/redbeat/actions :alt: Actions Status
.. image:: https://readthedocs.org/projects/redbeat/badge/?version=latest&style=flat :target: https://redbeat.readthedocs.io/en/latest/ :alt: ReadTheDocs
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code style: black
RedBeat <https://github.com/sibson/redbeat>_ is a
Celery Beat Scheduler <http://celery.readthedocs.org/en/latest/userguide/periodic-tasks.html>_
that stores the scheduled tasks and runtime metadata in Redis <http://redis.io/>_.
#. Dynamic live task creation and modification, without lengthy downtime #. Externally manage tasks from any language with Redis bindings #. Shared data store; Beat isn't tied to a single drive or machine #. Fast startup even with a large task count #. Prevent accidentally running multiple Beat servers
For more background on the genesis of RedBeat see this blog post <https://blog.heroku.com/redbeat-celery-beat-scheduler>_
Install with pip:
.. code-block:: console
pip install celery-redbeat
Configure RedBeat settings in your Celery configuration file:
.. code-block:: python
redbeat_redis_url = "redis://localhost:6379/1"
Then specify the scheduler when running Celery Beat:
.. code-block:: console
celery beat -S redbeat.RedBeatScheduler
RedBeat uses a distributed lock to prevent multiple instances running. To disable this feature, set:
.. code-block:: python
redbeat_lock_key = None
More details available on Read the Docs <https://redbeat.readthedocs.io/en/latest/>_
RedBeat is available on GitHub <https://github.com/sibson/redbeat>_
Once you have the source you can run the tests with the following commands::
pip install -r requirements-dev.txt
python -m unittest discover tests
You can also quickly fire up a sample Beat instance with::
celery beat --config exampleconf
FAQs
A Celery Beat Scheduler using Redis for persistent storage
We found that celery-redbeat demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.