| Name | im-data-manager-workflow-engine JSON |
| Version |
1.0.0a24
JSON |
| download |
| home_page | None |
| Summary | The Data Manager workflow engine, schema and decoder. |
| upload_time | 2025-03-28 12:12:03 |
| maintainer | None |
| docs_url | None |
| author | Alan Christie |
| requires_python | <4.0,>=3.13 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Informatics Matters Data Manager Workflow Engine
================================================
.. image:: https://badge.fury.io/py/im-data-manager-workflow-engine.svg
:target: https://badge.fury.io/py/im-data-manager-workflow-engine
:alt: PyPI package (latest)
.. image:: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/build.yaml/badge.svg
:target: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/build.yaml
:alt: Build
.. image:: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/publish.yaml/badge.svg
:target: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/publish.yaml
:alt: Publish
A package that simplifies the validation and decoding of Data Manager
Workflow definitions.
Installation (Python)
=====================
The Job decoder is published on `PyPI`_ and can be installed from there:
pip install im-data-manager-workflow-engine
Once installed you can validate the workflow definition (expected to be a dictionary
formed from the definition YAML file) with:
>>> from workflow import decoder
>>> error: Optional[str] = decoder.validate_schema(workflow)
.. _PyPI: https://pypi.org/project/im-data-manager-workflow-engine
Contributing
============
The project's written in Python and uses `Poetry`_ for dependency and package
management. We also use `pre-commit`_ to manage our pre-commit hooks, which
rely on `black`_, `mypy`_, `pylint`_, amongst others.
Create your environment::
poetry shell
poetry install --with dev
pre-commit install -t commit-msg -t pre-commit
And then start by running the pre-commit hooks to ensure you're stating with a
_clean_ project::
pre-commit run --all-files
And then run the tests::
coverage run -m pytest
coverage report
.. _Poetry: https://python-poetry.org
.. _pre-commit: https://pre-commit.com
.. _black: https://github.com/psf/black
.. _mypy: https://github.com/python/mypy
.. _pylint: https://pypi.org/project/pylint/
Get in touch
============
- Report bugs, suggest features or view the source code `on GitHub`_.
.. _on GitHub: https://github.com/informaticsmatters/squonk2-data-manager-workflow-engine
Raw data
{
"_id": null,
"home_page": null,
"name": "im-data-manager-workflow-engine",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.13",
"maintainer_email": null,
"keywords": null,
"author": "Alan Christie",
"author_email": "achristie@informaticsmatters.com",
"download_url": null,
"platform": null,
"description": "Informatics Matters Data Manager Workflow Engine\n================================================\n\n.. image:: https://badge.fury.io/py/im-data-manager-workflow-engine.svg\n :target: https://badge.fury.io/py/im-data-manager-workflow-engine\n :alt: PyPI package (latest)\n\n.. image:: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/build.yaml/badge.svg\n :target: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/build.yaml\n :alt: Build\n\n.. image:: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/publish.yaml/badge.svg\n :target: https://github.com/InformaticsMatters/squonk2-data-manager-workflow-engine/actions/workflows/publish.yaml\n :alt: Publish\n\nA package that simplifies the validation and decoding of Data Manager\nWorkflow definitions.\n\nInstallation (Python)\n=====================\n\nThe Job decoder is published on `PyPI`_ and can be installed from there:\n\n pip install im-data-manager-workflow-engine\n\nOnce installed you can validate the workflow definition (expected to be a dictionary\nformed from the definition YAML file) with:\n\n >>> from workflow import decoder\n >>> error: Optional[str] = decoder.validate_schema(workflow)\n\n.. _PyPI: https://pypi.org/project/im-data-manager-workflow-engine\n\nContributing\n============\n\nThe project's written in Python and uses `Poetry`_ for dependency and package\nmanagement. We also use `pre-commit`_ to manage our pre-commit hooks, which\nrely on `black`_, `mypy`_, `pylint`_, amongst others.\n\nCreate your environment::\n\n poetry shell\n poetry install --with dev\n pre-commit install -t commit-msg -t pre-commit\n\nAnd then start by running the pre-commit hooks to ensure you're stating with a\n_clean_ project::\n\n pre-commit run --all-files\n\nAnd then run the tests::\n\n coverage run -m pytest\n coverage report\n\n.. _Poetry: https://python-poetry.org\n.. _pre-commit: https://pre-commit.com\n.. _black: https://github.com/psf/black\n.. _mypy: https://github.com/python/mypy\n.. _pylint: https://pypi.org/project/pylint/\n\nGet in touch\n============\n\n- Report bugs, suggest features or view the source code `on GitHub`_.\n\n.. _on GitHub: https://github.com/informaticsmatters/squonk2-data-manager-workflow-engine\n\n",
"bugtrack_url": null,
"license": null,
"summary": "The Data Manager workflow engine, schema and decoder.",
"version": "1.0.0a24",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6bbc7c58d7c88ce06ecc2b7dd364b4bfdb41a83b8632626c3e6a6a5d91acf922",
"md5": "8b61841c54c080ecc942b388a3fda782",
"sha256": "6d2485868e7aee326719fe48cd9c3d3f9e08d05a397f9237c27cd9d09af74a8c"
},
"downloads": -1,
"filename": "im_data_manager_workflow_engine-1.0.0a24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b61841c54c080ecc942b388a3fda782",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.13",
"size": 15012,
"upload_time": "2025-03-28T12:12:03",
"upload_time_iso_8601": "2025-03-28T12:12:03.052056Z",
"url": "https://files.pythonhosted.org/packages/6b/bc/7c58d7c88ce06ecc2b7dd364b4bfdb41a83b8632626c3e6a6a5d91acf922/im_data_manager_workflow_engine-1.0.0a24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-28 12:12:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "im-data-manager-workflow-engine"
}
