Skip to main content

Asynchronous background tasks for Python web-frameworks with no dependencies

Project description

autocron

autocron is a Python background task library with no dependencies beside the standard library. It works out of the box with webframeworks like django, pyramid, flask, bottle, tornado or starlette.

autocron makes it easy to delegate long running and recurring tasks to external processes. No hassle with configuration-files.

autocron is designed for the vast majority of webapplications that don't need massive scaling. And don't want to add unnecessary dependencies.

Installation

For installation use pip:

    $ pip install autocron

or conda:

    $ conda install autocron

Quickstart

autocron provides two decorators: cron that takes a string in cron-format as argument, but accepts also keyword-arguments like minutes and hours. And delay to delegate a long running task to a background process.

Here is a simple example how to use autocron with the flask web-framework that can be run with $ flask --app application run:

    # application.py

    import autocron
    from flask import Flask

    app = Flask(__name__)
    autocron.start("the_flask_app.db")

    @autocron.cron("* * * * *")
    def cronjob():
        # do something from time to time ...

    @autocron.delay
    def do_this_later():
        # time consuming task here ...

    @app.route("/later")
    def later():
        do_this_later()
        return "delayed action triggered"

After creating the flask app instance calling autocron.start(<databasename>) starts the background workers. The cron decorated cronjob() function will get executed every minute and the delay decorated do_this_later() function gets delegated to the background worker every time the application processes the /later url. Terminating the application will shut down the worker processes.

More information and examples how to use autocron with other frameworks are at the documentation.

Documentation

The full documentation and release notes are at https://autocron.readthedocs.org

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

autocron-1.1.0.tar.gz (30.7 kB view details)

Uploaded Source

Built Distribution

autocron-1.1.0-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file autocron-1.1.0.tar.gz.

File metadata

  • Download URL: autocron-1.1.0.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for autocron-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ea849ab237d662792a23b48ab5beb02030127ac99b08c2eb792f9bd02e1f5f7c
MD5 d2325184207b90b7fe73b043424d68f5
BLAKE2b-256 25e586f205bdf6ba17eb3757935c5c6c4b55c1c145ce7d898c70634ffd5acd9e

See more details on using hashes here.

File details

Details for the file autocron-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: autocron-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 34.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for autocron-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb49e741752c54506a487288711577423628f21ae417b28c7035fa2f4d5e2376
MD5 492a2f8035c0f40ccb2a6530a341f4ef
BLAKE2b-256 a4d5cc894b377970da2d715c18de699f444986ad29d0ffbefa2f18b8f43cf05e

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