Weaver CLI and Client

Once Weaver package is installed (see Installation), it provides a command line interface (CLI) as well as a Python weaver.cli.WeaverClient to allow simplified interactions through shell calls or Python scripts.

This offers to the user methods to use file references (e.g.: local CWL Application Package definition) to rapidly operate with functionalities such as Deploy, Describe, Execute and any other operation described in Managing Processes included in Weaver ADES/EMS section.

Note

Technically, any OGC API - Processes implementation could be supported using the provided CLI and weaver.cli.WeaverClient. There are however some operations such as Uploading File to the Vault feature (and any utility that makes use of it) that are applicable only for Weaver instances.

Please refer to following sections for more details.

Python Client Commands 

For details about using the Python weaver.cli.WeaverClient, please refer directly to its class documentation and its underlying methods.

Shell CLI Commands 

Following are the detail for the shell CLI which provides the same features.

Run Weaver operations.

usage: weaver [-h] [--stdout] [--log LOG]
              [--quiet | --debug | --verbose | --log-level {DEBUG,ERROR,INFO,WARN}]
              [--version]
              {info,version,conformance,deploy,undeploy,register,unregister,capabilities,processes,describe,package,execute,jobs,update-job,trigger-job,monitor,dismiss,status,inputs,logs,exceptions,errors,statistics,stats,provenance,prov,results,upload}
              ...

Optional Arguments 

--version, -V: Display the version of the package.

Logging Arguments 

Options that configure output logging.

--stdout

Enforce logging to stdout for display in console.

Default: False

--log, --log-file

Output file to write generated logs.

--quiet, -q

Do not output anything else than error.

Default: False

--debug, -d

Enable extra debug logging.

Default: False

--verbose, -v

Output informative logging details.

Default: False

--log-level, -l

Possible choices: DEBUG, ERROR, INFO, WARN

Explicit log level to employ (default: None, case-insensitive).

Operations 

Name of the operation to run.

operation: Possible choices: info, version, conformance, deploy, undeploy, register, unregister, capabilities, processes, describe, package, execute, jobs, update-job, trigger-job, monitor, dismiss, status, inputs, logs, exceptions, errors, statistics, stats, provenance, prov, results, upload

Sub-commands 

info 

Retrieve server information from the landing page.

weaver info [-h] -u URL [-nL | -wL] [-nH | -wH]
            [-F {HTML,HTML+RAW,HTML+STR,JSON,JSON+RAW,JSON+STR,TEXT,TXT,XML,XML+RAW,XML+STR,YAML,YML}]
            [-rT REQUEST_TIMEOUT] [-rR REQUEST_RETRIES] [-rO OPTION]
            [-H HEADER] [-aC AUTH_HANDLER_CLASS] [-aI IDENTITY] [-aP PASSWORD]
            [-aU AUTH_URL] [-aM HTTP_METHOD] [-aH HEADER] [-aT TOKEN]
            [--stdout] [--log LOG]
            [--quiet | --debug | --verbose | --log-level {DEBUG,ERROR,INFO,WARN}]

Required Arguments

-u, --url: URL of the instance to run operations.

Output Arguments

Parameters to control specific options related to output format and contents.

-nL, --no-links

Remove “links” section from returned result body.

Default: True

-wL, --with-links

Preserve “links” section from returned result body (default).

Default: True

-nH, --no-headers

Omit response headers, only returning the result body (default).

Default: False

-wH, --with-headers

Return response headers additionally to the result body.

Default: False

-F, --format

Possible choices: HTML, HTML+RAW, HTML+STR, JSON, JSON+RAW, JSON+STR, TEXT, TXT, XML, XML+RAW, XML+STR, YAML, YML

Select an alternative output representation (default: JSON+STR, case-insensitive).

HTML: Representation as HTML content formatted as serialized string.

HTML+RAW: Representation as HTML content formatted as raw string without indentation or newlines.

HTML+STR: Representation as HTML content formatted as string with indentation and newlines.

JSON: Representation as JSON (object), which can still be manipulated in code.

JSON+RAW: Representation as JSON content formatted as raw string without any indentation or newlines.

JSON+STR: Representation as JSON content formatted as string with indentation and newlines.

TEXT: Representation as plain text content without any specific reformatting or validation.

TXT: Representation as plain text content without any specific reformatting or validation.

XML: Representation as XML content formatted as serialized string.

XML+RAW: Representation as XML content formatted as raw string without indentation or newlines.

XML+STR: Representation as XML content formatted as string with indentation and newlines.

YAML: Representation as YAML content formatted as string with indentation and newlines.

YML: Alias to YAML.

Request Arguments

Parameters to control specific options related to HTTP request handling.

-rT, --request-timeout

Maximum timeout duration (seconds) to wait for a response when performing HTTP requests (default: 5s).

Default: 5

-rR, --request-retries

Amount of attempt to retry HTTP requests in case of failure (default: no retry).

-rO, --request-option

Additional request options to apply for sending requests toward the service. This parameter can be provided multiple times, each with a value formatted as:

setting_name=setting_value

Setting names are case-insensitive. Quotes can be used in the setting_value portion to delimit it. Surrounding spaces are trimmed. Refer to the documentation for supported request option names.

-H, --header

Additional headers to apply for sending requests toward the service. This parameter can be provided multiple times, each with a value formatted as:

Header-Name: value

Header names are case-insensitive. Quotes can be used in the value portion to delimit it. Surrounding spaces are trimmed. Note that overridden headers expected by requests and the service could break some functionalities.

Service Authentication Arguments

Parameters to obtain access to a protected service using a request authentication handler.

-aC, --auth-class, --auth-handler

Script or module path reference to class implementation to handle inline request authentication.

Format path/to/script.py:module.AuthHandlerClass or installed.module.AuthHandlerClass is expected.

Utility definitions are available as:

weaver.cli.BasicAuthHandler
weaver.cli.BearerAuthHandler
weaver.cli.CookieAuthHandler

Custom implementations are allowed for more advanced use cases.

-aI, --auth-identity, --auth-username

Authentication identity (or username) to be passed down to the specified Authentication Handler.

-aP, --auth-password

Authentication password to be passed down to the specified Authentication Handler.

-aU, --auth-url

Authentication URL to be passed down to the specified Authentication Handler.

-aM, --auth-method

Possible choices: GET, HEAD, POST, PUT, DELETE

Authentication HTTP request method to be passed down to the specified Authentication Handler (default: GET, case-insensitive).

Default: GET

-aH, --auth-header

Additional headers to apply for sending requests when using the authentication handler. This option can be provided multiple times, each with a value formatted as:

Header-Name: value

Header names are case-insensitive. Quotes can be used in the value portion to delimit it. Surrounding spaces are trimmed.

-aT, --auth-token

Token to be added directly to the request headers. If this is specified, the authenticator will not make an additional authentication request in order to obtain a token. The token specified here will be used instead.

Logging Arguments

Options that configure output logging.

--stdout

Enforce logging to stdout for display in console.

Default: False

--log, --log-file

Output file to write generated logs.

--quiet, -q

Do not output anything else than error.

Default: False

--debug, -d

Enable extra debug logging.

Default: False

--verbose, -v

Output informative logging details.

Default: False

--log-level, -l

Possible choices: DEBUG, ERROR, INFO, WARN

Explicit log level to employ (default: None, case-insensitive).

version 

Retrieve server version.

weaver version [-h] -u URL [-nL | -wL] [-nH | -wH]
               [-F {HTML,HTML+RAW,HTML+STR,JSON,JSON+RAW,JSON+STR,TEXT,TXT,XML,XML+RAW,XML+STR,YAML,YML}]
               [-rT REQUEST_TIMEOUT] [-rR REQUEST_RETRIES] [-rO OPTION]
               [-H HEADER] [-aC AUTH_HANDLER_CLASS] [-aI IDENTITY]
               [-aP PASSWORD] [-aU AUTH_URL] [-aM HTTP_METHOD] [-aH HEADER]
               [-aT TOKEN] [--stdout] [--log LOG]
               [--quiet | --debug | --verbose | --log-level {DEBUG,ERROR,INFO,WARN}]

Required Arguments

-u, --url: URL of the instance to run operations.