data¶

Command-line tool¶

Manage execution data collection.

usage: bosh data [--help] {inspect,publish,delete}

Positional Arguments¶

action

Possible choices: inspect, publish, delete

Manage execution data records. Inspect: displays the unpublished records currently in the cache. Publish: publishes contents of cache to Zenodo as a public data set. Requires a Zenodo access token, see http://developers.zenodo.org/#authentication. Delete: remove one or more records from the cache.

Named Arguments¶

--help, -h

show this help message and exit

Default: False

data delete¶

Delete data record(s) in cache.

usage: bosh data delete [-h] [-f FILE] [--no-int]

Named Arguments¶

-f, --file

Filename of record to delete.

--no-int, -y

disable interactive input.

Default: False

data inspect¶

Displays contents of cache

usage: bosh data inspect [-h] [-e]

Named Arguments¶

-e, --example

Display example data file contents.

Default: False

data publish¶

Publishes record(s) to a data set.

usage: bosh data publish [-h] [-a AUTHOR] [-f FILE] [-i] [--no-int] [-v]
                         [--sandbox] [--zenodo-token ZENODO_TOKEN] [--nexus]
                         [--nexus-token NEXUS_TOKEN] [--nexus-org NEXUS_ORG]
                         [--nexus-project NEXUS_PROJECT]

Named Arguments¶

-a, --author

Set the author name for the data set publication. Defaults to anonymous.

-f, --file

Filename of record to publish alone as a data set.

-i, --individually

Publishes all data files in cache as independent data sets, By Default will publish files in bulk data sets.

Default: False

--no-int, -y

disable interactive input.

Default: False

-v, --verbose

print information messages.

Default: False

--sandbox

publish to Zenodo’s sandbox instead of production server. Recommended for tests.

Default: False

--zenodo-token

Zenodo API token to use for authentication. If not used, token will be read from configuration file or requested interactively.

--nexus

Publish to Nexus instead of Zenodo. Sandbox URL is https://sandbox.bluebrainnexus.io

Default: False

--nexus-token

Nexus API token to use for authentication.

--nexus-org

Nexus organization to publish to.

--nexus-project

Nexus project to publish to.

Python API¶

boutiques.data(*params): Refer to the Command-line tool section above