Skip to main content

A simple Django app to run celery tasks as processes.

Project description

=====
Process Engine
=====

Process Engine is used in conjunction with celery to create async process from
celery tasks via an API


Quick start
-----------

1. Add "processengine" to your INSTALLED_APPS setting like this::

INSTALLED_APPS = [
...
'processengine',
]

2. Include the router URLconf in your project urls.py like this::

from processengine.api import router as process_router
...

urlpatterns = [
url(r'^processengine/', include(process_router.urls)),
...
]

3. Add the PROCESS_MAP settings with your processes and the tasks to run like
so::

PROCESS_MAP = {
'my.process': [
'path.to.taskfile.task',
],
...
}

3. (Optional) Add settings for Slack Notifications. Note that if you add a SLACK_WEBHOOK setting we assume you will also have the other settings present.::
SLACK_WEBHOOK = "https://hooks.slack.com/services/T051CQH14/VWVRAAFA5/lPz2y84gM0JUoVllBow0Glcx"
SLACK_PROCESS_CHANNEL = "#Processes"
SLACK_PROCESS_USERNAME = "Someuser"
SLACK_PROCESS_EMOJI = ":ghost:"

4. Run `python manage.py migrate` to create the processengine models.

5. to create a process run a POST to http://127.0.0.1:8000/processengine/process/
with the following data::

data = {
name: "my.process", # This is the name of your process set in PROCESS_MAP variable
context: {
"name": "value" # This is the data that you pass through to your task
}
}

Note: Your tasks need to conform to the pattern of json in and json out

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

django-processengine-0.2.1.tar.gz (8.7 kB view hashes)

Uploaded Source

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