### Install REANA-Client Source: https://github.com/reanahub/reana-client/blob/master/README.md This snippet outlines the process for installing the REANA-Client. It covers creating a new virtual environment, activating it, and then installing the client package using pip. ```console $ # create new virtual environment $ virtualenv ~/.virtualenvs/reana $ source ~/.virtualenvs/reana/bin/activate $ # install reana-client $ pip install reana-client ``` -------------------------------- ### REANA Client General Options Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Describes the global options available for the REANA client CLI, including log level settings and help. ```APIDOC REANA Client CLI Options: Usage: reana-client [OPTIONS] COMMAND [ARGS]... Options: -l, --loglevel [DEBUG|INFO|WARNING] Sets log level --help Show this message and exit. ``` -------------------------------- ### REANA CLI Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/index.md Documentation for the REANA command-line interface, generated using the click library. This section details all available commands, their subcommands, options, and arguments, providing a complete reference for interacting with REANA services via the CLI. ```APIDOC reana-client A command-line interface for interacting with the REANA workflow management system. Usage: reana-client [OPTIONS] [ARGS]... Commands: run Submit a new workflow run. list List workflow runs. status Get the status of workflow runs. logs Get logs for a workflow run. get-file Download a file from a workflow run. submit Submit a new workflow. delete Delete a workflow. status Get the status of a workflow. list List workflows. create Create a new REANA client configuration. login Log in to a REANA server. logout Log out from a REANA server. config Manage REANA client configuration. version Show the REANA client version. For detailed information on each command, use 'reana-client --help'. ``` -------------------------------- ### REANA Client Workflow Run Test Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for testing workflow execution using Gherkin files. ```APIDOC REANA Client Workflow Run Test Commands: test Test workflow execution, based on a given Gherkin file. - Executes a workflow and validates its behavior against scenarios defined in a Gherkin file. ``` -------------------------------- ### REANA Client Workflow Management Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for creating, deleting, comparing, and listing workflows on the REANA server. ```APIDOC REANA Client Workflow Management Commands: create Create a new workflow. - Initiates a new workflow based on a specification. delete Delete a workflow. - Removes a specified workflow from the REANA server. diff Show diff between two workflows. - Compares two workflow specifications and shows the differences. list List all workflows and sessions. - Retrieves and displays a list of all existing workflows and their associated sessions. ``` -------------------------------- ### Run REANA Client Tests Source: https://github.com/reanahub/reana-client/blob/master/CONTRIBUTING.md Executes the test suite for the REANA client project. This script is used to verify code changes and ensure that the project's functionality remains intact before submitting pull requests. ```console $ ./run-tests.sh ``` -------------------------------- ### REANA Client Configuration and Status Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands to retrieve cluster information, check server connectivity, and display the REANA server version. ```APIDOC REANA Client Configuration and Status Commands: info List cluster general information. - Retrieves and displays general information about the REANA cluster. ping Check connection to REANA server. - Verifies connectivity to the REANA server. version Show version. - Displays the version of the REANA server. ``` -------------------------------- ### REANA Client Workspace Interactive Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for managing interactive sessions within the REANA workspace. ```APIDOC REANA Client Workspace Interactive Commands: close Close an interactive session. - Terminates an active interactive session within the workspace. open Open an interactive session inside the workspace. - Establishes a new interactive session within the workspace environment. ``` -------------------------------- ### REANA Client Workspace File Management Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for managing files and directories within the REANA workspace, including upload, download, listing, and deletion. ```APIDOC REANA Client Workspace File Management Commands: download Download workspace files. - Retrieves files or directories from the workspace to the local system. du Get workspace disk usage. - Reports the disk space usage of files and directories within the workspace. ls List workspace files. - Displays the contents (files and directories) of the workspace. mv Move files within workspace. - Renames or moves files and directories within the workspace. prune Prune workspace files. - Removes specific files or directories from the workspace based on criteria. rm Delete files from workspace. - Permanently removes specified files or directories from the workspace. upload Upload files and directories to workspace. - Transfers files or directories from the local system to the workspace. ``` -------------------------------- ### REANA Client Quota Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for displaying user quota information on the REANA server. ```APIDOC REANA Client Quota Commands: quota-show Show user quota. - Displays the current user's quota usage and limits. ``` -------------------------------- ### REANA Client Workspace File Retention Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for listing and managing file retention rules for workflows. ```APIDOC REANA Client Workspace File Retention Commands: retention-rules-list List the retention rules for a workflow. - Displays the configured retention rules applied to a workflow's workspace files. ``` -------------------------------- ### REANA Client API Source: https://github.com/reanahub/reana-client/blob/master/docs/index.md API documentation for the REANA client library, detailing the available methods for programmatic interaction with REANA services. This includes functions for managing workflow runs, submitting workflows, retrieving status, and accessing files. ```APIDOC reana_client.api.client.API Provides methods to interact with the REANA API. __init__(self, config_dir='~/.reana', default_workspace='.') Initializes the REANA client API. Parameters: config_dir (str): Directory containing REANA configuration files. default_workspace (str): Default workspace directory. submit_run(self, workflow_json, workflow_parameters=None, run_name=None, workspace=None) Submits a new workflow run. Parameters: workflow_json (dict or str): The workflow specification in JSON format. workflow_parameters (dict, optional): Parameters for the workflow. run_name (str, optional): A custom name for the run. workspace (str, optional): The workspace directory for the run. Returns: dict: Information about the submitted run. list_runs(self, status=None, workflow_id=None) Lists workflow runs. Parameters: status (str, optional): Filter runs by status. workflow_id (str, optional): Filter runs by workflow ID. Returns: list: A list of workflow run dictionaries. get_run_status(self, run_id) Retrieves the status of a specific workflow run. Parameters: run_id (str): The ID of the workflow run. Returns: dict: The status information for the run. get_run_logs(self, run_id) Retrieves the logs for a specific workflow run. Parameters: run_id (str): The ID of the workflow run. Returns: str: The logs for the run. get_run_file(self, run_id, filename, destination=None) Downloads a file from a workflow run. Parameters: run_id (str): The ID of the workflow run. filename (str): The name of the file to download. destination (str, optional): The path to save the downloaded file. submit_workflow(self, workflow_file, workflow_name=None) Submits a new workflow definition. Parameters: workflow_file (str): Path to the workflow definition file. workflow_name (str, optional): A name for the workflow. Returns: dict: Information about the submitted workflow. delete_workflow(self, workflow_id) Deletes a workflow definition. Parameters: workflow_id (str): The ID of the workflow to delete. list_workflows(self, status=None) Lists workflow definitions. Parameters: status (str, optional): Filter workflows by status. Returns: list: A list of workflow dictionaries. create_config(self, server_url, username, password, access_token=None, config_file='~/.reana/config.yaml') Creates a REANA client configuration file. Parameters: server_url (str): The URL of the REANA server. username (str): The username for authentication. password (str): The password for authentication. access_token (str, optional): An access token for authentication. config_file (str): The path to save the configuration file. login(self, config_file='~/.reana/config.yaml') Logs in to the REANA server using the configuration file. Parameters: config_file (str): The path to the configuration file. logout(self, config_file='~/.reana/config.yaml') Logs out from the REANA server. Parameters: config_file (str): The path to the configuration file. get_config(self, config_file='~/.reana/config.yaml') Retrieves the current REANA client configuration. Parameters: config_file (str): The path to the configuration file. Returns: dict: The configuration dictionary. set_config(self, key, value, config_file='~/.reana/config.yaml') Sets a configuration option. Parameters: key (str): The configuration key to set. value (str): The value for the configuration key. config_file (str): The path to the configuration file. get_client_version(self) Returns the version of the REANA client. Returns: str: The client version string. ``` -------------------------------- ### REANA Client Workflow Execution Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for managing the execution lifecycle of workflows, including logs, restarts, runs, status checks, stopping, and validation. ```APIDOC REANA Client Workflow Execution Commands: logs Get workflow logs. - Retrieves logs for a specified workflow run. restart Restart previously run workflow. - Restarts a workflow that has been previously executed. run Shortcut to create, upload, start a new workflow. - A convenience command to perform the create, upload, and start sequence for a new workflow. start Start previously created workflow. - Initiates the execution of a workflow that has already been created. status Get status of a workflow. - Retrieves the current status of a specified workflow run. stop Stop a running workflow. - Halts the execution of a currently running workflow. validate Validate workflow specification file. - Checks a workflow specification file for correctness and adherence to schema. ``` -------------------------------- ### REANA Client Workflow Sharing Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for managing workflow sharing permissions with other users. ```APIDOC REANA Client Workflow Sharing Commands: share-add Share a workflow with other users (read-only). - Grants read-only access to a workflow for specified users. share-remove Unshare a workflow. - Revokes sharing permissions for a workflow from specified users. share-status Show with whom a workflow is shared. - Displays the list of users with whom a workflow is currently shared. ``` -------------------------------- ### REANA Client Secret Management Commands Source: https://github.com/reanahub/reana-client/blob/master/docs/cmd_list.txt Commands for managing user secrets, including adding, deleting, and listing them. ```APIDOC REANA Client Secret Management Commands: secrets-add Add secrets from literal string or from file. - Stores sensitive information (secrets) provided as a string or from a file. secrets-delete Delete user secrets by name. - Removes previously stored secrets identified by their names. secrets-list List user secrets. - Displays all currently stored user secrets. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.