Quick start#

NOTE: Red Engine has been renamed as Rocketry

Warning

This documentation is out of date. The project continues under: https://rocketry.readthedocs.io

Topics of the section:

  • Installing

  • Minimal example

Installing#

Install the package from PyPI:

pip install redengine

Minimal Example#

Next, we make a quick and minimal application:

from redengine import RedEngine

app = RedEngine()

@app.task('daily')
def do_things():
    ...

if __name__ == "__main__":
    app.run()

We initialized the RedEngine application, created one task which runs every day and then we started the app. This is nothing fancy but gets you stared.

What next#

This is only a small slice what Red Engine has to offer. Read furher to explore the features.