|Linux Build Status| |Code coverage| |Documentation Status|
.. |Linux Build Status| image:: https://github.com/common-workflow-language/cwl-utils/actions/workflows/ci-tests.yml/badge.svg?branch=main
:target: https://github.com/common-workflow-language/cwl-utils/actions/workflows/ci-tests.yml
.. |Code coverage| image:: https://codecov.io/gh/common-workflow-language/cwl-utils/branch/main/graph/badge.svg
:target: https://codecov.io/gh/common-workflow-language/cwl-utils
.. |Documentation Status| image:: https://readthedocs.org/projects/cwl-utils/badge/?version=latest
:target: https://cwl-utils.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
cwl-utils
---------
Python Utilities and Autogenerated Classes for loading and parsing `CWL
v1.0 <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/v1_0.py>`__,
`CWL
v1.1 <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/v1_1.py>`__,
and `CWL
v1.2 <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/v1_2.py>`__
documents.
Requires Python 3.8+
Installation
------------
::
pip3 install cwl-utils
To install from source::
git clone https://github.com/common-workflow-language/cwl-utils.git
cd cwl-utils
pip3 install .
Usage
-----
Pull the all referenced software container images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``cwl-docker-extract`` is useful to cache or pre-pull all software
container images referenced in a CWL CommandLineTool or CWL Workflow
(including all referenced CommandLineTools and sub-Workflows and so on).
The default behaviour is to use the Docker engine to download and save
the software container images in Docker format.
.. code:: bash
cwl-docker-extract path_to_my_workflow.cwl
.. code:: bash
cwl-docker-extract --dir DIRECTORY path_to_my_workflow.cwl
Or you can use the Singularity software container engine to download and
save the software container images and convert them to the Singularity
format at the same time.
.. code:: bash
cwl-docker-extract --singularity --dir DIRECTORY path_to_my_workflow.cwl
Print all referenced software packages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``cwl-cite-extract`` prints all software packages found (recursively) in the
specified CWL document.
Currently the package name and any listed specs and version field are printed
for all ``SoftwareRequirement`` s found.
.. code:: bash
cwl-cite-extract path_to_my_workflow.cwl
Replace CWL Expressions with concrete steps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``cwl-expression-refactor`` refactors CWL documents so that any CWL Expression
evaluations are separate steps (either CWL ExpressionTools or CWL CommandLineTools.)
This allows execution by CWL engines that do not want to support inline expression
evaluation outside of concrete steps, or do not want to directly support CWL's
optional ``InlineJavascriptRequirement`` at all.
.. code:: bash
cwl-expression-refactor directory/path/to/save/outputs path_to_my_workflow.cwl [more_workflows.cwl]
Split a packed CWL document
~~~~~~~~~~~~~~~~~~~~~~~~~~~
``cwl-graph-split`` splits a packed CWL document file into multiple files.
Packed CWL documents use the $graph construct to contain multiple CWL Process
objects (Workflow, CommandLineTool, ExpressionTool, Operation). Typically
packed CWL documents contain a CWL Workflow under the name "main" and the
workflow steps (including any sub-workflows).
.. code:: bash
cwl-graph-split --outdir optional/directory/path/to/save/outputs path_to_my_workflow.cwl
Normalize a CWL document
~~~~~~~~~~~~~~~~~~~~~~~~
``cwl-normalizer`` normalizes one or more CWL document so that for each document,
a JSON format CWL document is produces with it and all of its dependencies packed
together, upgrading to CWL v1.2, as needed. Can optionally refactor CWL
Expressions into separate steps in the manner of cwl-expression-refactor.
.. code:: bash
cwl-normalizer directory/path/to/save/outputs path_to_my_workflow.cwl [more_workflows.cwl]
Using the CWL Parsers
~~~~~~~~~~~~~~~~~~~~~
.. code:: python
from pathlib import Path
from ruamel import yaml
import sys
from cwl_utils.parser import load_document_by_uri, save
# File Input - This is the only thing you will need to adjust or take in as an input to your function:
cwl_file = Path("testdata/md5sum.cwl") # or a plain string works as well
# Import CWL Object
cwl_obj = load_document_by_uri(cwl_file)
# View CWL Object
print("List of object attributes:\n{}".format("\n".join(map(str, dir(cwl_obj)))))
# Export CWL Object into a built-in typed object
saved_obj = save(cwl_obj)
print(f"Export of the loaded CWL object: {saved_obj}.")
Development
-----------
Regenerate parsers
~~~~~~~~~~~~~~~~~~
To regenerate install the ``schema_salad`` package and run:
``cwl_utils/parser/cwl_v1_0.py`` was created via
``schema-salad-tool --codegen python https://github.com/common-workflow-language/common-workflow-language/raw/codegen/v1.0/CommonWorkflowLanguage.yml --codegen-parser-info "org.w3id.cwl.v1_0" > cwl_utils/parser/cwl_v1_0.py``
``cwl_utils/parser/cwl_v1_1.py`` was created via
``schema-salad-tool --codegen python https://github.com/common-workflow-language/cwl-v1.1/raw/codegen/CommonWorkflowLanguage.yml --codegen-parser-info "org.w3id.cwl.v1_1" > cwl_utils/parser/cwl_v1_1.py``
``cwl_utils/parser/cwl_v1_2.py`` was created via
``schema-salad-tool --codegen python https://github.com/common-workflow-language/cwl-v1.2/raw/1.2.1_proposed/CommonWorkflowLanguage.yml --codegen-parser-info "org.w3id.cwl.v1_2" > cwl_utils/parser/cwl_v1_2.py``
Release
~~~~~~~
To release CWLUtils, bump the version in ``cwl_utils/__meta__.py``, and
tag that commit with the new version. The
`gh-action-pypi-publish <https://github.com/pypa/gh-action-pypi-publish>`__
should release that tag.
Raw data
{
"_id": null,
"home_page": "https://github.com/common-workflow-language/cwl-utils",
"name": "cwl-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Common workflow language working group",
"author_email": "common-workflow-language@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/45/8d/a0e5f14a39c4689b47a1f40abb9ca8cdd897b8b78d05bf7779de57ee2b90/cwl-utils-0.32.tar.gz",
"platform": null,
"description": "|Linux Build Status| |Code coverage| |Documentation Status|\n\n.. |Linux Build Status| image:: https://github.com/common-workflow-language/cwl-utils/actions/workflows/ci-tests.yml/badge.svg?branch=main\n :target: https://github.com/common-workflow-language/cwl-utils/actions/workflows/ci-tests.yml\n.. |Code coverage| image:: https://codecov.io/gh/common-workflow-language/cwl-utils/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/common-workflow-language/cwl-utils\n.. |Documentation Status| image:: https://readthedocs.org/projects/cwl-utils/badge/?version=latest\n :target: https://cwl-utils.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\ncwl-utils\n---------\n\nPython Utilities and Autogenerated Classes for loading and parsing `CWL\nv1.0 <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/v1_0.py>`__,\n`CWL\nv1.1 <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/v1_1.py>`__,\nand `CWL\nv1.2 <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/v1_2.py>`__\ndocuments.\n\nRequires Python 3.8+\n\nInstallation\n------------\n\n::\n\n pip3 install cwl-utils\n\nTo install from source::\n\n git clone https://github.com/common-workflow-language/cwl-utils.git\n cd cwl-utils\n pip3 install .\n\nUsage\n-----\n\nPull the all referenced software container images\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n``cwl-docker-extract`` is useful to cache or pre-pull all software\ncontainer images referenced in a CWL CommandLineTool or CWL Workflow\n(including all referenced CommandLineTools and sub-Workflows and so on).\n\nThe default behaviour is to use the Docker engine to download and save\nthe software container images in Docker format.\n\n.. code:: bash\n\n cwl-docker-extract path_to_my_workflow.cwl\n\n.. code:: bash\n\n cwl-docker-extract --dir DIRECTORY path_to_my_workflow.cwl\n\nOr you can use the Singularity software container engine to download and\nsave the software container images and convert them to the Singularity\nformat at the same time.\n\n.. code:: bash\n\n cwl-docker-extract --singularity --dir DIRECTORY path_to_my_workflow.cwl\n\n\nPrint all referenced software packages\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n``cwl-cite-extract`` prints all software packages found (recursively) in the\nspecified CWL document.\n\nCurrently the package name and any listed specs and version field are printed\nfor all ``SoftwareRequirement`` s found.\n\n.. code:: bash\n\n cwl-cite-extract path_to_my_workflow.cwl\n\n\nReplace CWL Expressions with concrete steps\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n``cwl-expression-refactor`` refactors CWL documents so that any CWL Expression\nevaluations are separate steps (either CWL ExpressionTools or CWL CommandLineTools.)\nThis allows execution by CWL engines that do not want to support inline expression\nevaluation outside of concrete steps, or do not want to directly support CWL's\noptional ``InlineJavascriptRequirement`` at all.\n\n\n.. code:: bash\n\n cwl-expression-refactor directory/path/to/save/outputs path_to_my_workflow.cwl [more_workflows.cwl]\n\nSplit a packed CWL document\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n``cwl-graph-split`` splits a packed CWL document file into multiple files.\n\nPacked CWL documents use the $graph construct to contain multiple CWL Process\nobjects (Workflow, CommandLineTool, ExpressionTool, Operation). Typically\npacked CWL documents contain a CWL Workflow under the name \"main\" and the\nworkflow steps (including any sub-workflows).\n\n.. code:: bash\n\n cwl-graph-split --outdir optional/directory/path/to/save/outputs path_to_my_workflow.cwl\n\nNormalize a CWL document\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n``cwl-normalizer`` normalizes one or more CWL document so that for each document,\na JSON format CWL document is produces with it and all of its dependencies packed\ntogether, upgrading to CWL v1.2, as needed. Can optionally refactor CWL\nExpressions into separate steps in the manner of cwl-expression-refactor.\n\n.. code:: bash\n\n cwl-normalizer directory/path/to/save/outputs path_to_my_workflow.cwl [more_workflows.cwl]\n\n\nUsing the CWL Parsers\n~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n from pathlib import Path\n from ruamel import yaml\n import sys\n\n from cwl_utils.parser import load_document_by_uri, save\n\n # File Input - This is the only thing you will need to adjust or take in as an input to your function:\n cwl_file = Path(\"testdata/md5sum.cwl\") # or a plain string works as well\n\n # Import CWL Object\n cwl_obj = load_document_by_uri(cwl_file)\n\n # View CWL Object\n print(\"List of object attributes:\\n{}\".format(\"\\n\".join(map(str, dir(cwl_obj)))))\n\n # Export CWL Object into a built-in typed object\n saved_obj = save(cwl_obj)\n print(f\"Export of the loaded CWL object: {saved_obj}.\")\n\nDevelopment\n-----------\n\nRegenerate parsers\n~~~~~~~~~~~~~~~~~~\n\nTo regenerate install the ``schema_salad`` package and run:\n\n``cwl_utils/parser/cwl_v1_0.py`` was created via\n``schema-salad-tool --codegen python https://github.com/common-workflow-language/common-workflow-language/raw/codegen/v1.0/CommonWorkflowLanguage.yml --codegen-parser-info \"org.w3id.cwl.v1_0\" > cwl_utils/parser/cwl_v1_0.py``\n\n``cwl_utils/parser/cwl_v1_1.py`` was created via\n``schema-salad-tool --codegen python https://github.com/common-workflow-language/cwl-v1.1/raw/codegen/CommonWorkflowLanguage.yml --codegen-parser-info \"org.w3id.cwl.v1_1\" > cwl_utils/parser/cwl_v1_1.py``\n\n``cwl_utils/parser/cwl_v1_2.py`` was created via\n``schema-salad-tool --codegen python https://github.com/common-workflow-language/cwl-v1.2/raw/1.2.1_proposed/CommonWorkflowLanguage.yml --codegen-parser-info \"org.w3id.cwl.v1_2\" > cwl_utils/parser/cwl_v1_2.py``\n\nRelease\n~~~~~~~\n\nTo release CWLUtils, bump the version in ``cwl_utils/__meta__.py``, and\ntag that commit with the new version. The\n`gh-action-pypi-publish <https://github.com/pypa/gh-action-pypi-publish>`__\nshould release that tag.\n\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "",
"version": "0.32",
"project_urls": {
"Homepage": "https://github.com/common-workflow-language/cwl-utils"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3ccc0761ae4dab49d8fd263efaba8f79f66782357693e42500ea5d88213a72d",
"md5": "0ad8ca397a633733de0194b729c3f270",
"sha256": "5239ce4781e61c0b5c467593c10ffcb342dedd0a79e4c86c37b89b467129c333"
},
"downloads": -1,
"filename": "cwl_utils-0.32-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ad8ca397a633733de0194b729c3f270",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 360683,
"upload_time": "2023-12-01T19:02:33",
"upload_time_iso_8601": "2023-12-01T19:02:33.491948Z",
"url": "https://files.pythonhosted.org/packages/e3/cc/c0761ae4dab49d8fd263efaba8f79f66782357693e42500ea5d88213a72d/cwl_utils-0.32-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "458da0e5f14a39c4689b47a1f40abb9ca8cdd897b8b78d05bf7779de57ee2b90",
"md5": "c1534c3df1d887a4a4947210ff2776df",
"sha256": "2849bd217db1f0ec4e66a80c6646f58a3f72d0d7def28ebe85a362861ae2931b"
},
"downloads": -1,
"filename": "cwl-utils-0.32.tar.gz",
"has_sig": false,
"md5_digest": "c1534c3df1d887a4a4947210ff2776df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 303618,
"upload_time": "2023-12-01T19:02:35",
"upload_time_iso_8601": "2023-12-01T19:02:35.274164Z",
"url": "https://files.pythonhosted.org/packages/45/8d/a0e5f14a39c4689b47a1f40abb9ca8cdd897b8b78d05bf7779de57ee2b90/cwl-utils-0.32.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 19:02:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "common-workflow-language",
"github_project": "cwl-utils",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "cwl-utils"
}
JSON
