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.

Getting started

Install the ewoksserver Python package

pip install ewoksserver

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_EXECUTION = {"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_EXECUTION = {
    "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-2.0.1.tar.gz (42.6 kB view details)

Uploaded Source

File details

Details for the file ewoksserver-2.0.1.tar.gz.

File metadata

  • Download URL: ewoksserver-2.0.1.tar.gz
  • Upload date:
  • Size: 42.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for ewoksserver-2.0.1.tar.gz
Algorithm Hash digest
SHA256 77d83f41543a379ff451e90b467b1b295f0c12aa598d2133aebde711e5dace56
MD5 e6712be3fef1ab182792a25a0d479cb8
BLAKE2b-256 0aec70174a5826d1e986700ab16d5d402b08f205d1de352036e33a0c42a5f9a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page