| Name | ewoksserver JSON |
| Version |
2.1.1
JSON |
| download |
| home_page | None |
| Summary | Backend for ewoksweb |
| upload_time | 2025-08-03 18:18:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | # MIT License
**Copyright (c) 2021 European Synchrotron Radiation Facility**
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ewoksserver
ewoksserver is a REST server to manage and execute [ewoks](https://ewoks.readthedocs.io/) workflows.
It serves as a backend for [ewoksweb](https://ewoksweb.readthedocs.io/) and emits ewoks execution events over Socket.IO.
## Getting started
Install the [ewoksserver](https://ewoksserver.readthedocs.io/en/latest/) Python package
```
pip install ewoksserver
```
## Development
Install from source
```bash
pip install -e .[dev]
```
Run tests
```bash
pytest
```
Launch the backend
```bash
ewoks-server
```
or for an installation with the system python
```bash
python3 -m ewoksserver.server
```
## Configuration
The configuration keys are uppercase variables in a python script:
```python
# /tmp/config.py
RESOURCE_DIRECTORY = "/path/to/resource/directory/"
EWOKS_EXECUTION = {"handlers": ...}
CELERY = {"broker_url":...}
```
Specify the configuration file through the CLI
```bash
ewoks-server --config /tmp/config.py
```
or using the environment variable EWOKSSERVER_SETTINGS
```bash
export EWOKSSERVER_SETTINGS=/tmp/config.py
ewoks-server
```
### Example
```python
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/
Raw data
{
"_id": null,
"home_page": null,
"name": "ewoksserver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "ESRF <dau-pydev@esrf.fr>",
"download_url": "https://files.pythonhosted.org/packages/9e/c0/19fad1679fc4e0ede4e20b84ce55968fd8c9d95b2c4009fb960c5fa1ce59/ewoksserver-2.1.1.tar.gz",
"platform": null,
"description": "# ewoksserver\n\newoksserver is a REST server to manage and execute [ewoks](https://ewoks.readthedocs.io/) workflows.\n\nIt serves as a backend for [ewoksweb](https://ewoksweb.readthedocs.io/) and emits ewoks execution events over Socket.IO.\n\n## Getting started\n\nInstall the [ewoksserver](https://ewoksserver.readthedocs.io/en/latest/) Python package\n\n```\npip install ewoksserver\n```\n\n## Development\n\nInstall from source\n\n```bash\npip install -e .[dev]\n```\n\nRun tests\n\n```bash\npytest\n```\n\nLaunch the backend\n\n```bash\newoks-server\n```\n\nor for an installation with the system python\n\n```bash\npython3 -m ewoksserver.server\n```\n\n## Configuration\n\nThe configuration keys are uppercase variables in a python script:\n\n```python\n# /tmp/config.py\nRESOURCE_DIRECTORY = \"/path/to/resource/directory/\"\n\nEWOKS_EXECUTION = {\"handlers\": ...}\n\nCELERY = {\"broker_url\":...}\n```\n\nSpecify the configuration file through the CLI\n\n```bash\newoks-server --config /tmp/config.py\n```\n\nor using the environment variable EWOKSSERVER_SETTINGS\n\n```bash\nexport EWOKSSERVER_SETTINGS=/tmp/config.py\newoks-server\n```\n\n### Example\n\n```python\nimport os\n\n_SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))\n\nRESOURCE_DIRECTORY = os.path.join(_SCRIPT_DIR, \"resources\")\n\nEWOKS_EXECUTION = {\n \"handlers\": [\n {\n \"class\": \"ewokscore.events.handlers.Sqlite3EwoksEventHandler\",\n \"arguments\": [\n {\n \"name\": \"uri\",\n \"value\": \"file:\" + os.path.join(_SCRIPT_DIR, \"ewoks_events.db\"),\n }\n ],\n }\n ]\n}\n```\n\n## Documentation\n\nhttps://ewoksserver.readthedocs.io/\n",
"bugtrack_url": null,
"license": "# MIT License\n \n **Copyright (c) 2021 European Synchrotron Radiation Facility**\n \n Permission is hereby granted, free of charge, to any person obtaining a copy of\n this software and associated documentation files (the \"Software\"), to deal in\n the Software without restriction, including without limitation the rights to\n use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\n the Software, and to permit persons to whom the Software is furnished to do so,\n subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\n COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\n IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n ",
"summary": "Backend for ewoksweb",
"version": "2.1.1",
"project_urls": {
"Changelog": "https://gitlab.esrf.fr/workflow/ewoks/ewoksserver/-/blob/main/CHANGELOG.md",
"Documentation": "https://workflow.gitlab-pages.esrf.fr/ewoks/ewoksserver",
"Homepage": "https://gitlab.esrf.fr/workflow/ewoks/ewoksserver",
"Issues": "https://gitlab.esrf.fr/workflow/ewoks/ewoksserver/issues",
"Repository": "https://gitlab.esrf.fr/workflow/ewoks/ewoksserver"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9ec019fad1679fc4e0ede4e20b84ce55968fd8c9d95b2c4009fb960c5fa1ce59",
"md5": "7d11705efe457d54db9c41b1cb9603ca",
"sha256": "6a9e3f197be23ca0664cd4b454c641ccd664ff5f36c0089a594053675ba7b3dd"
},
"downloads": -1,
"filename": "ewoksserver-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7d11705efe457d54db9c41b1cb9603ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 42005,
"upload_time": "2025-08-03T18:18:20",
"upload_time_iso_8601": "2025-08-03T18:18:20.856811Z",
"url": "https://files.pythonhosted.org/packages/9e/c0/19fad1679fc4e0ede4e20b84ce55968fd8c9d95b2c4009fb960c5fa1ce59/ewoksserver-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-03 18:18:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ewoksserver"
}
