Skip to main content

Backend for ewoksweb

Project description

ewoksserver

Pipeline Code style: black License Coverage Docs PyPI

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ewoksserver-2.1.2-py3-none-any.whl (57.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ewoksserver-2.1.2.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ewoksserver-2.1.2.tar.gz
Algorithm Hash digest
SHA256 17956e59cf25645da94141a14fea3f733e91504a7ea42b41ecc95304d919da3e
MD5 49484cef4f4155f40a6b97a31a807ec5
BLAKE2b-256 af93c6fd24cd77fe3305276c7faf2d3aa861c53a386652197c917b3fef0ff9e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ewoksserver-2.1.2.tar.gz:

Publisher: release.yml on ewoks-kit/ewoksserver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ewoksserver-2.1.2-py3-none-any.whl.

File metadata

  • Download URL: ewoksserver-2.1.2-py3-none-any.whl
  • Upload date:
  • Size: 57.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ewoksserver-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6e06febdeb4ab4ebbaff0b6eb5423f04c9929b092aabfddf91fb28320f13e287
MD5 530f08b7b30d1d09066879a5bb8fd97d
BLAKE2b-256 f7fae90283ca40d912aba6f9a7ff1cb2981929c6ec980c55769281fb9fa7d4ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for ewoksserver-2.1.2-py3-none-any.whl:

Publisher: release.yml on ewoks-kit/ewoksserver

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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