https://github.com/zmap/celerybeat-mongo

A Celery Beat Scheduler that uses MongoDB to store both schedule definitions and status information
https://github.com/zmap/celerybeat-mongo

Last synced: about 1 year ago
JSON representation

A Celery Beat Scheduler that uses MongoDB to store both schedule definitions and status information

• Host: GitHub
• URL: https://github.com/zmap/celerybeat-mongo
• Owner: zmap
• License: apache-2.0
• Created: 2014-04-02T15:46:05.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-11-16T10:42:33.000Z (over 3 years ago)
• Last Synced: 2024-04-14T18:13:23.208Z (about 2 years ago)
• Language: Python
• Size: 77.1 KB
• Stars: 123
• Watchers: 17
• Forks: 43
• Open Issues: 17
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
celerybeat-mongo

################

This is a `Celery Beat Scheduler `_

that stores both the schedules themselves and their status

information in a backend Mongo database. It can be installed by

installing the celerybeat-mongo Python egg::

    # pip install celerybeat-mongo

And specifying the scheduler when running Celery Beat, e.g.::

    $ celery beat -S celerybeatmongo.schedulers.MongoScheduler

Settings

########

The settings for the scheduler are defined in your celery configuration file

similar to how other aspects of Celery are configured:

* mongodb_scheduler_url: The mongodb `url `_ connection used to store task results.

* mongodb_scheduler_db: The Mongodb database name

* mongodb_scheduler_collection (optional): the collection name used by model. If no value are specified, the default value will be used: **schedules**.

Usage

===================

Celerybeat-mongo just supports Interval and Crontab schedules.

Schedules easily can be manipulated using the mongoengine models in celerybeat mongo.models module.

Example creating interval-based periodic task

---------------------------------------------

To create a periodic task executing at an interval you must first

create the interval object::

    from celery import Celery

    config = {

        "mongodb_scheduler_db": "my_project",

        "mongodb_scheduler_url": "mongodb://localhost:27017",

    }

    app = Celery('hello', broker='redis://localhost//')

    app.conf.update(**config)

    from celerybeatmongo.models import PeriodicTask

    periodic = PeriodicTask(

        name='Importing contacts',

        task="proj.import_contacts"

        interval=PeriodicTask.Interval(every=10, period="seconds") # executes every 10 seconds.

    )

    periodic.save()

.. note::

    You should import celerybeat-mongo just after celery initialization.

Example creating crontab periodic task

---------------------------------------------

A crontab schedule has the fields: minute, hour, day_of_week, day_of_month and month_of_year, so if you want the equivalent of a 30 7 * * 1 (Executes every Monday morning at 7:30 a.m) crontab entry you specify::

    from celery import Celery

    config = {

        "mongodb_scheduler_db": "my_project",

        "mongodb_scheduler_url": "mongodb://localhost:27017",

    }

    app = Celery('hello', broker='redis://localhost//')

    app.conf.update(**config)

    from celerybeatmongo.models import PeriodicTask

    periodic = PeriodicTask(name="Send Email Notification", task="proj.notify_customers")

    periodic.crontab = PeriodicTask.Crontab(minute="30", hour="7", day_of_week="1",

                               day_of_month="0", month_of_year="*")

    periodic.save()