Metadata-Version: 2.1
Name: redengine
Version: 0.2.2
Summary: Advanced Task Launch System (scheduling)
Home-page: UNKNOWN
Author: Mikael Koli
Author-email: koli.mikael@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas (>=1.0.0)
Requires-Dist: pytest (>=5.0.1)
Requires-Dist: psutil (>=5.7.0)
Requires-Dist: pyyaml (>=5.3.1)


# <span style="color:red">Red</span> Engine

> Advanced scheduling system for humans.

---

## What is it?
Red Engine is a Python package for scheduling scripts or functions. It is designed to be intuitive, 
expressive, extendable and production ready. 

## Core Features

- **Task:** a task can take various forms, for example:
    - a function,
    - a script or
    - create your own task class
- **Scheduling:** intuitive scheduling syntax.
    - All of these are valid instructions for scheduling a task:
        - `daily`
        - `every 10 minutes`
        - `weekly between Tuesday and Wednesday & after task 'another task'`
- **Parallerization:** Redengine supports many ways to execute a task: 
    - in another process,
    - in another thread or
    - in the main thread and process
- **Parametrization:** parametrize individual tasks or share them between the session. 
- **Easy start:** just install the package, use the premade configurations and work on your project.
- **Extendable:** everything is just a building block and the most is made to be modified. 

## Installation

- Clone the source code and pip install:
```shell
git clone https://github.com/Miksus/redengine.git
cd redengine
pip install .
```

## Getting Started

```shell
python -m redengine create myproject
```
See [the docs](https://red-engine.readthedocs.io/en/latest/) for more.

---

## Author

* **Mikael Koli** - [Miksus](https://github.com/Miksus) - koli.mikael@gmail.com



