cwltool


Namecwltool JSON
Version 1.0.20170217172322 PyPI version JSON
home_pagehttps://github.com/common-workflow-language/cwltool
SummaryCommon workflow language reference implementation
upload_time2017-02-17 17:26:36
maintainer
docs_urlNone
authorCommon workflow language working group
requires_python
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements requests ruamel.yaml rdflib rdflib-jsonld shellescape schema-salad
Travis-CI
Coveralis test coverage
            ==================================================================
Common workflow language tool description reference implementation
==================================================================

CWL Conformance test: |Build Status|

This is the reference implementation of the Common Workflow Language.  It is
intended to be feature complete and provide comprehensive validation of CWL
files as well as provide other tools related to working with CWL.

This is written and tested for Python 2.7.

The reference implementation consists of two packages.  The "cwltool" package
is the primary Python module containing the reference implementation in the
"cwltool" module and console executable by the same name.

The "cwlref-runner" package is optional and provides an additional entry point
under the alias "cwl-runner", which is the implementation-agnostic name for the
default CWL interpreter installed on a host.

Install
-------

Installing the official package from PyPi (will install "cwltool" package as
well)::

  pip install cwlref-runner

If installling alongside another CWL implementation then::

  pip install cwltool

To install from source::

  git clone https://github.com/common-workflow-language/cwltool.git
  cd cwltool && python setup.py install
  cd cwlref-runner && python setup.py install  # co-installing? skip this

Remember, if co-installing multiple CWL implementations then you need to
maintain which implementation ``cwl-runner`` points to via a symbolic file
system link or [another facility](https://wiki.debian.org/DebianAlternatives).

Run on the command line
-----------------------

Simple command::

  cwl-runner [tool-or-workflow-description] [input-job-settings]

Or if you have multiple CWL implementations installed and you want to override
the default cwl-runner use::

  cwltool [tool-or-workflow-description] [input-job-settings]

Import as a module
----------------

Add::

  import cwltool

to your script.

Use with boot2docker
--------------------
boot2docker is running docker inside a virtual machine and it only mounts ``Users``
on it. The default behavoir of CWL is to create temporary directories under e.g.
``/Var`` which is not accessible to Docker containers.

To run CWL successfully with boot2docker you need to set the ``--tmpdir-prefix``
and ``--tmp-outdir-prefix`` to somewhere under ``/Users``::

    $ cwl-runner --tmp-outdir-prefix=/Users/username/project --tmpdir-prefix=/Users/username/project wc-tool.cwl wc-job.json

.. |Build Status| image:: https://ci.commonwl.org/buildStatus/icon?job=cwltool-conformance
   :target: https://ci.commonwl.org/job/cwltool-conformance/

Tool or workflow loading from remote or local locations
-------------------------------------------------------

``cwltool`` can run tool and workflow descriptions on both local and remote
systems via its support for HTTP[S] URLs.

Input job files and Workflow steps (via the `run` directive) can reference CWL
documents using absolute or relative local filesytem paths. If a relative path
is referenced and that document isn't found in the current directory then the
following locations will be searched:
http://www.commonwl.org/v1.0/CommandLineTool.html#Discovering_CWL_documents_on_a_local_filesystem

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "coveralis": true, 
    "keywords": "", 
    "tox": true, 
    "requirements": [
        {
            "name": "requests", 
            "specs": [
                [
                    ">=", 
                    "1.0"
                ]
            ]
        }, 
        {
            "name": "ruamel.yaml", 
            "specs": [
                [
                    "==", 
                    "0.13.7"
                ]
            ]
        }, 
        {
            "name": "rdflib", 
            "specs": [
                [
                    "==", 
                    "4.2.1"
                ]
            ]
        }, 
        {
            "name": "rdflib-jsonld", 
            "specs": [
                [
                    "==", 
                    "0.4.0"
                ]
            ]
        }, 
        {
            "name": "shellescape", 
            "specs": [
                [
                    "==", 
                    "3.4.1"
                ]
            ]
        }, 
        {
            "name": "schema-salad", 
            "specs": [
                [
                    ">=", 
                    "2.1.20170208112505"
                ], 
                [
                    "<", 
                    "3"
                ]
            ]
        }
    ], 
    "author": "Common workflow language working group", 
    "home_page": "https://github.com/common-workflow-language/cwltool", 
    "github_user": "common-workflow-language", 
    "download_url": "https://pypi.python.org/packages/97/b6/b9d5be514f53e2ff170e8d58cdff1c61a32e08fa8a5f5c96d98614d1bacb/cwltool-1.0.20170217172322.tar.gz", 
    "platform": "", 
    "version": "1.0.20170217172322", 
    "cheesecake_documentation_id": null, 
    "description": "==================================================================\nCommon workflow language tool description reference implementation\n==================================================================\n\nCWL Conformance test: |Build Status|\n\nThis is the reference implementation of the Common Workflow Language.  It is\nintended to be feature complete and provide comprehensive validation of CWL\nfiles as well as provide other tools related to working with CWL.\n\nThis is written and tested for Python 2.7.\n\nThe reference implementation consists of two packages.  The \"cwltool\" package\nis the primary Python module containing the reference implementation in the\n\"cwltool\" module and console executable by the same name.\n\nThe \"cwlref-runner\" package is optional and provides an additional entry point\nunder the alias \"cwl-runner\", which is the implementation-agnostic name for the\ndefault CWL interpreter installed on a host.\n\nInstall\n-------\n\nInstalling the official package from PyPi (will install \"cwltool\" package as\nwell)::\n\n  pip install cwlref-runner\n\nIf installling alongside another CWL implementation then::\n\n  pip install cwltool\n\nTo install from source::\n\n  git clone https://github.com/common-workflow-language/cwltool.git\n  cd cwltool && python setup.py install\n  cd cwlref-runner && python setup.py install  # co-installing? skip this\n\nRemember, if co-installing multiple CWL implementations then you need to\nmaintain which implementation ``cwl-runner`` points to via a symbolic file\nsystem link or [another facility](https://wiki.debian.org/DebianAlternatives).\n\nRun on the command line\n-----------------------\n\nSimple command::\n\n  cwl-runner [tool-or-workflow-description] [input-job-settings]\n\nOr if you have multiple CWL implementations installed and you want to override\nthe default cwl-runner use::\n\n  cwltool [tool-or-workflow-description] [input-job-settings]\n\nImport as a module\n----------------\n\nAdd::\n\n  import cwltool\n\nto your script.\n\nUse with boot2docker\n--------------------\nboot2docker is running docker inside a virtual machine and it only mounts ``Users``\non it. The default behavoir of CWL is to create temporary directories under e.g.\n``/Var`` which is not accessible to Docker containers.\n\nTo run CWL successfully with boot2docker you need to set the ``--tmpdir-prefix``\nand ``--tmp-outdir-prefix`` to somewhere under ``/Users``::\n\n    $ cwl-runner --tmp-outdir-prefix=/Users/username/project --tmpdir-prefix=/Users/username/project wc-tool.cwl wc-job.json\n\n.. |Build Status| image:: https://ci.commonwl.org/buildStatus/icon?job=cwltool-conformance\n   :target: https://ci.commonwl.org/job/cwltool-conformance/\n\nTool or workflow loading from remote or local locations\n-------------------------------------------------------\n\n``cwltool`` can run tool and workflow descriptions on both local and remote\nsystems via its support for HTTP[S] URLs.\n\nInput job files and Workflow steps (via the `run` directive) can reference CWL\ndocuments using absolute or relative local filesytem paths. If a relative path\nis referenced and that document isn't found in the current directory then the\nfollowing locations will be searched:\nhttp://www.commonwl.org/v1.0/CommandLineTool.html#Discovering_CWL_documents_on_a_local_filesystem\n", 
    "upload_time": "2017-02-17 17:26:36", 
    "lcname": "cwltool", 
    "bugtrack_url": "", 
    "github": true, 
    "name": "cwltool", 
    "license": "Apache 2.0", 
    "travis_ci": true, 
    "github_project": "cwltool", 
    "summary": "Common workflow language reference implementation", 
    "split_keywords": [], 
    "author_email": "common-workflow-language@googlegroups.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-02-17T17:26:39", 
            "comment_text": "", 
            "python_version": "2.7", 
            "url": "https://pypi.python.org/packages/43/e8/9516732160ce2912af1d539d9d575d350bb96e8d2e582bce9635f8f9bfd8/cwltool-1.0.20170217172322-py2-none-any.whl", 
            "md5_digest": "b230213b69f41c5e213b4fef8f5b9981", 
            "downloads": 0, 
            "filename": "cwltool-1.0.20170217172322-py2-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "43/e8/9516732160ce2912af1d539d9d575d350bb96e8d2e582bce9635f8f9bfd8/cwltool-1.0.20170217172322-py2-none-any.whl", 
            "size": 277669
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-02-17T17:26:36", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/97/b6/b9d5be514f53e2ff170e8d58cdff1c61a32e08fa8a5f5c96d98614d1bacb/cwltool-1.0.20170217172322.tar.gz", 
            "md5_digest": "899c22688bfcc5c361a6c192ab1872ef", 
            "downloads": 0, 
            "filename": "cwltool-1.0.20170217172322.tar.gz", 
            "packagetype": "sdist", 
            "path": "97/b6/b9d5be514f53e2ff170e8d58cdff1c61a32e08fa8a5f5c96d98614d1bacb/cwltool-1.0.20170217172322.tar.gz", 
            "size": 222117
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}