Skip to main content

Backend for ewoksweb

Project description

ewoksserver

ewoksserver is a REST server to manage and execute ewoks workflows.

It serves as a backend for ewoksweb and emits ewoks execution events over Socket.IO.

Development

Install from source

pip install -e .[dev]

Run tests

pytest

Launch the backend

ewoks-server

or for an installation with the system python

python3 -m ewoksserver.server

Configuration

The configuration keys are uppercase variables in a python script:

# /tmp/config.py
RESOURCE_DIRECTORY = "/path/to/resource/directory/"

EWOKS = {"handlers": ...}

CELERY = {"broker_url":...}

Specify the configuration file through the CLI

ewoks-server --config /tmp/config.py

or using the environment variable EWOKSSERVER_SETTINGS

export EWOKSSERVER_SETTINGS=/tmp/config.py
ewoks-server

Example

import os

_SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))

RESOURCE_DIRECTORY = os.path.join(_SCRIPT_DIR, "resources")

EWOKS = {
    "handlers": [
        {
            "class": "ewokscore.events.handlers.Sqlite3EwoksEventHandler",
            "arguments": [
                {
                    "name": "uri",
                    "value": "file:" + os.path.join(_SCRIPT_DIR, "ewoks_events.db"),
                }
            ],
        }
    ]
}

Documentation

https://ewoksserver.readthedocs.io/

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

ewoksserver-1.1.0.tar.gz (35.1 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