Skip to content

Command Line Interface

python-re3data.

Usage:

$ re3data [OPTIONS] COMMAND [ARGS]...

Options:

  • -V, --version: Show python-re3data version and exit.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • repository

re3data repository

Usage:

$ re3data repository [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List the metadata of all repositories in...
  • get: Get the metadata of a specific repository.

re3data repository list

List the metadata of all repositories in the re3data API.

Usage:

$ re3data repository list [OPTIONS]

Options:

  • --query TEXT: A query to filter the results. If provided, only repositories matching the query will be returned.
  • --return-type [csv|dataclass|dataframe|dict|json|response|xml]: [default: dataclass]
  • --count / --no-count: [default: no-count]
  • --outfile FILE
  • --help: Show this message and exit.

re3data repository get

Get the metadata of a specific repository.

Usage:

$ re3data repository get [OPTIONS] REPOSITORY_ID

Arguments:

  • REPOSITORY_ID: [required]

Options:

  • --return-type [csv|dataclass|dataframe|dict|json|response|xml]: [default: dataclass]
  • --outfile FILE
  • --help: Show this message and exit.