Package: reana-client
AboutREANA-Client is a component of theREANAreusable 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 datarun computational workflows on remote compute cloudslist submitted workflows and enquire about their statusesdownload results of finished workflowsInstallation$# create new virtual environment$virtualenv~/.virtualenvs/reana$source~/.virtualenvs/reana/bin/activate$# install reana-client$pipinstallreana-clientUsageThe detailed information on how to install and use REANA can be found indocs.reana.io.Useful linksREANA project home pageREANA user documentationREANA user support forumREANA-Client releasesREANA-Client developer documentationREANA-Client known issuesREANA-Client source codeChangesVersion 0.9.2 (2023-12-19)Changesvalidatecommand to show detailed errors when the specification file is not a valid YAML file.Changes the validation of specification files to show improved validation warnings, which also indicate where unexpected properties are located in the file.Fixescreate_workflow_from_jsonAPI function to always load and send the workflow specification to the server.Fixeslistcommand to accept case-insensitive column names when sorting the returned workflow runs via the--sortoption.Fixesrunwrapper command for workflows that do not containinputsclause in their specification.Version 0.9.1 (2023-09-27)Adds support for Python 3.12.Addsprunecommand to delete all intermediate files of a given workflow. Use with care.Changesopencommand to inform user about the auto-closure of interactive sessions after a certain inactivity timeout.Changesvalidatecommand to display non-critical validation warnings when checking the REANA specification file.Fixeslistcommand to correctly list workflows when sorting them by their run number or by the size of their workspace.Fixesducommand help message typo.Fixesvalidation--environmentscommand to correctly handle fully-qualified image names.Version 0.9.0 (2023-01-26)Adds support for Python 3.11.Adds support for.gitignoreand.reanaignoreto specify files that should not be uploaded to REANA.Addsretention-rules-listcommand to list the retention rules of a workflow.Changes REANA specification loading and validation functionalities by porting some of the logic toreana-commons.Changescreateandrestartcommands to always upload the REANA specification file.Changesdeletecommand to always delete the workflow’s workspace.Changesdelete_workflowPython API function to always delete the workflow’s workspace.Changesdownloadcommand to add the possibility to write files to the standard output via-o-option.Changeslistcommand to hide deleted workflows by default.Changeslistcommand to allow displaying deleted workflows via--alland--show-deleted-runsoptions.Changeslistandstatuscommands to allow displaying the duration of workflows with the--include-durationoption.Changesmvcommand to allow moving files while a workflow is running.Changesuploadcommand to prevent uploading symlinks.Changesvalidation--environmentcommand to use Docker registry v2 APIs to check that a Docker image exists in DockerHub.Fixeslistcommand to highlight the workflow specified inREANA_WORKONcorrectly.Fixessecrets-deletecommand error message when deleting non existing secrets.Fixesstartcommand to report failed workflows as errors.Fixesstartandruncommands to correctly follow the execution of the workflow until termination.Fixesstatuscommand to respect output format provided by the--formatoption.Fixesuploadcommand to report when input directories are listed under thefilessection in the REANA specification file and vice versa.Fixesvalidate--environmentcommand to detect illegal whitespace characters in Docker image names.Version 0.8.1 (2022-02-15)Adds support for creating reana-client standalone AppImage executables.Adds support for Python 3.10.Adds workflow name validation forcreate_workflow_from_json()Python API function.Fixes formatting of error messages and sets appropriate exit status codes.Version 0.8.0 (2021-11-24)Adds support for running and validating Snakemake workflows.Adds support foroutputs.directoriesinreana.yamlallowing to easily download output directories.Adds new commandquota-showto retrieve information about total CPU and Disk usage and quota limits.Adds new commandinfothat retrieves general information about the cluster, such as available workspace path settings.Changesvalidatecommand to add the possibility to check the workflow against server capabilities such as desired workspace path via–server-capabilitiesoption.Changeslistcommand to add the possibility to filter by workflow status and search by workflow name via--filteroption.Changeslistcommand to add the possibility to filter and display all the runs of a given workflow via-woption.Changeslistcommand to stop including workflow progress and workspace size by default. Please use new options–include-progressand–include-workspace-sizeto show this information.Changeslist--sessionscommand to display the status of interactive sessions.Changeslogscommand to display also the start and finish times of individual jobs.Changeslscommand to add the possibility to filter by file name, size and last-modified values via--filteroption.Changesducommand to add the possibility filter by file name and size via--filteroption.Changesdeletecommand to prevent hard-deletion of workflows.Changes Yadage workflow specification loading to be done inreana-commons.Changes CWL workflow engine tocwltoolversion3.1.20210628163208.Removes support for Python 2.7. Please use Python 3.6 or higher from now on.Version 0.7.5 (2021-07-05)Changes workflow validation to display more granular output.Changes workflow parameters validation to warn about misused parameters for each step.Changes dependencies to unpin six so that client may be installed in more contexts.Fixes environment image validation not to test repetitively the same image.Fixesupload_to_server()Python API function to silently skip uploading in case of none-like inputs.Version 0.7.4 (2021-04-28)Adds support of wildcard patterns tolscommand.Adds support of directory download and wildcard patterns todownloadcommand.Changeslistcommand to include deleted workflows by default.Fixes environment image validation info message where UIDs were switched.Version 0.7.3 (2021-03-24)Adds validation of workflow input parameters to thevalidatecommand.Adds optional validation of workflow environment images (--environments) to thevalidatecommand.Version 0.7.2 (2021-01-15)Adds support for Python 3.9.Fixes exception handling when uploading files.Fixes minor code warnings.Fixes traling slash issue from user exported REANA_SERVER_URL.Version 0.7.1 (2020-11-10)Changespingcommand output to include REANA client and server version information.Fixesuploadcommand to properly display errors.Version 0.7.0 (2020-10-20)Adds option tologscommand to filter job logs according to compute backend, docker image, status and step name.Adds newrestartcommand to restart previously run or failed workflows.Adds possibility to specify operational options in thereana.yamlof the workflow.Fixes user experience by preventing dots as part of the workflow name to avoid confusion with restart runs.Changesducommand output format.Changes file loading to optimise CLI performance.Changeslogscommand to enhance formatting using marks and colours.Changes from Bravado to requests to improve download performance.Changespingcommand to perform user access token validation.Changes defaults to accept bothreana.yamlandreana.ymlfilenames.Changesdiffcommand to improve output formatting.Changes code formatting to respectblackcoding style.Changes documentation to single-page layout.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 commandssecrets-add,secrets-listandsecrets-delete.Enhancesrunandcreatecommands to allow specifying
workfow via the--workflowflag.Introduces new commandversionto report client version.Fixesuploadcommand behaviour for uploading very large files.Simplifiesruncommand by removing free upload parameters.Upgradescwltoolto 1.0.20191022103248.Disables SSL verification warnings when talking to self-signed server
certificates.Version 0.5.0 (2019-04-24)Introduces newresourcesfield inreana.yamlspecification file
allowing to declare computing resources needed for workflow runs, such as the
CVMFS repositories viacvmfssubfield.Improvesreana-clientembedded command-line documentation (-help) by
grouping commands and providing concrete usage examples for all commands.Enhances workflowstartcommand allowing to override input parameters
(--parameter) and to specify additional operational options
(--option).Introduces new workflowrunwrapper command that creates workflow, uploads
its input data and code and starts its execution.Introduces new workflowstopcommand for stopping a running workflow.Enhances workflowlogscommand output capabilities via new--jsonoption.Introduces new workflowdiffcommand for comparing two workflow runs.Introduces new workflowdeletecommand for deleting one or more workflow
runs.Introduces new sessionopencommand allowing to run interactive sessions
such as Jupyter notebook upon workflow workspace.Introduces new sessionclosecommand for closing interactive sessions.Renames pastworkflowscommand tolistallowing to list both workflow
runs and interactive sessions.Introduces new workspaceducommand for checking workspace disk usage.Introduces new workspacemvcommand for moving files within workspace.Introduces new workspacermcommand for removing files within workspace.Renames past workspacelistcommand tolsallowing to list workspace
files. Enhances its output capabilities via new--formatoption.Introduces new API functioncreate_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 inreana.yamlin case no arguments are provided.Fixesstatuscommand’s JSON output mode.Upgrades CWL reference implementation to version1.0.20180912090223.Renames Serial workflow operational parameter fromCACHING``to``CACHE.Adds support for Python 3.7.Version 0.3.0 (2018-08-10)Adds support forSerial workflows.CLI refactored to a flat design:inputs/outputs/coderemoved, everything is a file managed
with upload/download/list commands.Removesworkflowcommand, workflows are managed withcreate/start/status.Removesanalyescommand, nowvalidateis first level command.statusnow 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 usingstartfor
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 newstatuscommand 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.Please bewarePlease 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.