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 websocket.

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-0.4.0.tar.gz (28.1 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: ewoksserver-0.4.0.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for ewoksserver-0.4.0.tar.gz
Algorithm Hash digest
SHA256 7585a9fa822662b5b070e4c103a3d327f543b7454b63a24341a3cfa0fe1a768d
MD5 fd1f9adc35594e0e5017c2435ed32157
BLAKE2b-256 48982f2363ca972cdbf27334c672405451b1421ed26a1c3d3e44d6fd7be8b798

See more details on using hashes here.

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