Skip to main content

Simple, generic cron-like job runner service for Django

Project description

https://badge.fury.io/py/bronski.svg https://img.shields.io/pypi/pyversions/bronski.svg https://github.com/uptick/bronski/workflows/Test/badge.svg

A beat server for Django, with cron-like syntax

Bronski allows you to configure periodic function calls using a Django model.

It is ideally suited to being a task “beat” sever, akin to celery-beat.

Install

$ pip install bronski

Setup

  1. Add ‘bronski’ to your INSTALLED_APPS

    This is only needed to enable the management command.

  2. Create a model in your own app that inherits from bronski.models.CrontabBase

  3. Create and apply migrations:

    $ manage.py makemigrations
    $ manage.py migrate
  4. Specify your model in settings

    CRONTAB_MODEL = "myapp.MyCronModel"
  5. Launch your beat server:

    $ ./manage.py bronski

Each minute the bronski service will scan the model for enabled jobs that haven’t been run in the past 59 seconds. It will then check each to see if its crontab definition matches the next minute.

For job records that match, their run method will be called. The default run method will:

  • get the specified function by calling self.get_function()

  • resolve the kwargs to use by calling self.get_kwargs()

  • invoke the function with the kwargs.

You can override run in your custom model to, for instance, enqueue jobs:

class Jobs(CrontabBase):

    def run(self):
        func = self.get_function()
        kwargs = self.get_kwargs()

        # Celery task API:
        func.delay(**kwargs)
        # Dramatiq actor API:
        func.send(**kwargs)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bronski-0.4.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

bronski-0.4.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file bronski-0.4.0.tar.gz.

File metadata

  • Download URL: bronski-0.4.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.0 CPython/3.8.0 Darwin/19.6.0

File hashes

Hashes for bronski-0.4.0.tar.gz
Algorithm Hash digest
SHA256 abcc5483feb54e641f21b5979cb15927e0cb952284789293ef1635eb5c4289b3
MD5 878b32a1007f9cbb4474939395884e07
BLAKE2b-256 e4f0216a6ef12dfd5ef5c20f5e266e3fdb4482df42b8f6b7e9497459cb5cd0a5

See more details on using hashes here.

File details

Details for the file bronski-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: bronski-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.0 CPython/3.8.0 Darwin/19.6.0

File hashes

Hashes for bronski-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2b36a1e18fd9a8ced3c88458ded01d28da6c15c960d42b85a4c211e0a6f06f2
MD5 9c67f70835e5f1e5bd48e311b5f41fda
BLAKE2b-256 cdcffb470de058c741c02eab4741a2a884ee86204a2ee2628d74d0a2b7fd6b72

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page