Metadata-Version: 2.1
Name: reana-client
Version: 0.7.0a1
Summary: REANA client
Home-page: https://github.com/reanahub/reana-client
Author: REANA
Author-email: info@reana.io
License: UNKNOWN
Description: ############
        REANA-Client
        ############
        
        .. image:: https://img.shields.io/pypi/pyversions/reana-client.svg
           :target: https://pypi.org/pypi/reana-client
        
        .. image:: https://img.shields.io/travis/reanahub/reana-client.svg
           :target: https://travis-ci.org/reanahub/reana-client
        
        .. image:: https://readthedocs.org/projects/reana-client/badge/?version=latest
           :target: https://reana-client.readthedocs.io/en/latest/?badge=latest
        
        .. image:: https://img.shields.io/coveralls/reanahub/reana-client.svg
           :target: https://coveralls.io/r/reanahub/reana-client
        
        .. image:: https://badges.gitter.im/Join%20Chat.svg
           :target: https://gitter.im/reanahub/reana?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
        
        .. image:: https://img.shields.io/github/license/reanahub/reana.svg
           :target: https://github.com/reanahub/reana-client/blob/master/LICENSE
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/psf/black
        
        About
        =====
        
        REANA-Client is a component of the `REANA <http://www.reana.io/>`_ reusable and
        reproducible research data analysis platform. It provides a command-line tool
        that allows researchers to submit, run, and manage their computational
        workflows.
        
        - seed workspace with input code and data
        - run computational workflows on remote compute clouds
        - list submitted workflows and enquire about their statuses
        - download results of finished workflows
        
        
        Installation
        ============
        
        .. code-block:: console
        
           $ # create new virtual environment
           $ virtualenv ~/.virtualenvs/reana
           $ source ~/.virtualenvs/reana/bin/activate
           $ # install reana-client
           $ pip install reana-client
        
        Usage
        =====
        
        The detailed information on how to install and use REANA can be found in
        `docs.reana.io <https://docs.reana.io>`_.
        
        
        Useful links
        ============
        
        - `REANA project home page <http://www.reana.io/>`_
        - `REANA user documentation <https://docs.reana.io>`_
        - `REANA user support forum <https://forum.reana.io>`_
        
        - `REANA-Client releases <https://reana-client.readthedocs.io/en/latest#changes>`_
        - `REANA-Client developer documentation <https://reana-client.readthedocs.io/>`_
        - `REANA-Client known issues <https://github.com/reanahub/reana-client/issues>`_
        - `REANA-Client source code <https://github.com/reanahub/reana-client>`_
        
        
        Changes
        =======
        
        Version master (UNRELEASED)
        ---------------------------
        
        - Adds option to filter job logs according to compute backend, docker image, status and steps.
        - Enriches disk usage output format.
        - Adds new command to restart workflows.
        - Optimizes CLI performance.
        - Adds option to get logs of a specific step.
        - Enhances logs formatting using marks and colors.
        - Switches from Bravado to ``requests`` to perform better performant downloads.
        - Validates user access token and improves output of ``ping`` command.
        - Accepts both ``reana.yaml`` and ``reana.yml`` filenames.
        - Includes better formatting for ``diff`` command.
        - Prevents including a dot as part of the workflow name.
        - Allows passing workflow operational options in the ``reana.yaml``.
        - Adds Black formatter support.
        
        Version 0.6.1 (2020-06-09)
        --------------------------
        
        - Fixes installation troubles for REANA 0.6.x release series by pinning several
          dependencies.
        
        Version 0.6.0 (2019-12-27)
        --------------------------
        
        - Introduces user secrets management commands ``secrets-add``,
          ``secrets-list`` and ``secrets-delete``.
        - Enhances ``run`` and ``create`` commands to allow specifying
          workfow via the ``--workflow`` flag.
        - Introduces new command ``version`` to report client version.
        - Fixes ``upload`` command behaviour for uploading very large files.
        - Simplifies ``run`` command by removing free upload parameters.
        - Upgrades ``cwltool`` to 1.0.20191022103248.
        - Disables SSL verification warnings when talking to self-signed server
          certificates.
        
        Version 0.5.0 (2019-04-24)
        --------------------------
        
        - Introduces new ``resources`` field in ``reana.yaml`` specification file
          allowing to declare computing resources needed for workflow runs, such as the
          CVMFS repositories via ``cvmfs`` subfield.
        - Improves ``reana-client`` embedded command-line documentation (``-help``) by
          grouping commands and providing concrete usage examples for all commands.
        - Enhances workflow ``start`` command allowing to override input parameters
          (``--parameter``) and to specify additional operational options
          (``--option``).
        - Introduces new workflow ``run`` wrapper command that creates workflow, uploads
          its input data and code and starts its execution.
        - Introduces new workflow ``stop`` command for stopping a running workflow.
        - Enhances workflow ``logs`` command output capabilities via new ``--json``
          option.
        - Introduces new workflow ``diff`` command for comparing two workflow runs.
        - Introduces new workflow ``delete`` command for deleting one or more workflow
          runs.
        - Introduces new session ``open`` command allowing to run interactive sessions
          such as Jupyter notebook upon workflow workspace.
        - Introduces new session ``close`` command for closing interactive sessions.
        - Renames past ``workflows`` command to ``list`` allowing to list both workflow
          runs and interactive sessions.
        - Introduces new workspace ``du`` command for checking workspace disk usage.
        - Introduces new workspace ``mv`` command for moving files within workspace.
        - Introduces new workspace ``rm`` command for removing files within workspace.
        - Renames past workspace ``list`` command to ``ls`` allowing to list workspace
          files. Enhances its output capabilities via new ``--format`` option.
        - Introduces new API function ``create_workflow_from_json()`` which allows
          developers and third-party systems to create workflows directly from JSON
          specification.
        
        Version 0.4.0 (2018-11-07)
        --------------------------
        
        - Enhances test suite and increases code coverage.
        - Changes license to MIT.
        
        Version 0.3.1 (2018-09-25)
        --------------------------
        
        - Amends upload and download commands that will now upload/download all the
          files specified in ``reana.yaml`` in case no arguments are provided.
        - Fixes ``status`` command's JSON output mode.
        - Upgrades CWL reference implementation to version ``1.0.20180912090223``.
        - Renames Serial workflow operational parameter from ``CACHING``to ``CACHE``.
        - Adds support for Python 3.7.
        
        Version 0.3.0 (2018-08-10)
        --------------------------
        
        - Adds support for
          `Serial workflows <http://reana-workflow-engine-serial.readthedocs.io/en/latest/>`_.
        - CLI refactored to a flat design:
            - ``inputs``/``outputs``/``code`` removed, everything is a file managed
              with upload/download/list commands.
            - Removes ``workflow`` command, workflows are managed with
              ``create``/``start``/``status``.
        - Removes ``analyes`` command, now ``validate`` is first level command.
        - ``status`` now shows the selected workflow progress and current command on
          verbose mode.
        - Requires the usage of an access token to talk to REANA Server.
        - Fixes bug when uploading binary files.
        - Supports addition of workflow engine parameters when using ``start`` for
          serial workflows.
        - Improves error messages.
        
        Version 0.2.0 (2018-04-20)
        --------------------------
        
        - Adds support for Common Workflow Language workflows.
        - Adds support for persistent user-selected workflow names.
        - Enables file and directory input uploading using absolute paths.
        - Adds new ``status`` command to display the current status of the client.
        - Reduces verbosity level for commands and improves error messages.
        
        Version 0.1.0 (2018-01-30)
        --------------------------
        
        - Initial public release.
        
        .. admonition:: Please beware
        
           Please note that REANA is in an early alpha stage of its development. The
           developer preview releases are meant for early adopters and testers. Please
           don't rely on released versions for any production purposes yet.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: docs
Provides-Extra: tests
Provides-Extra: all
