Metadata-Version: 2.1
Name: taskengine
Version: 0.0.2
Summary: TaskEngine for ProcessEngine
Home-page: https://github.com/SchoolOrchestration/ProcessEngineV2/tree/master/taskengine
Author: AppointmentGuru
Author-email: tech@appointmentguru.co
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

Library to handle exposing tasks to a ProcessEngine

## Getting started

```
pip install taskengine
```

**Add to installed apps**

**Confgure your task modules**

In settings.py:
```
INSTALLED_APPS = [
    ..
    'taskengine',
    ..
]
```

**Tell taskengine where to find tasks**

In settings.py:

```
ALLOWED_TASK_MODULES = {
    'taskengine.tasks', # these are default tasks provided by taskengine
    .., # <- your module/s here
}

# optional
TASKENGINE_API_KEY = '...'

```

**Add API to urls**

in urls.py
```
from taskengine.api import router as task_router
..

urlpatterns = [
    ..
    path(r'', include(task_router.urls)),
    ..
]
```

**Register your service**

```
python manage.py register
```

## Upading pip library

```
# update version in setup.py
python3 setup.py sdist bdist_wheel
twine upload dist/*
```

todo: dockerize this




