Boutiques

Bosh tool documentation

  • bosh
  • create
  • data
  • deprecate
  • evaluate
  • example
  • execute
  • exporter
  • importer
  • invocation
  • pprint
  • publish
  • pull
  • search
    • Command-line tool
      • Positional Arguments
      • Named Arguments
    • Python API
  • test
  • validate
Boutiques
  • Docs »
  • search
  • View page source

search¶

Command-line tool¶

Search Zenodo for Boutiques descriptors. When no term is supplied, will search for all descriptors.

usage: bosh search [-h] [-v] [--sandbox] [-m MAX] [-nt] [-e] [query]

Positional Arguments¶

query

Search query

Default: “boutiques”

Named Arguments¶

-v, --verbose

Print information messages

Default: False

--sandbox

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

Default: False

-m, --max

Specify the maximum number of results to be returned. Default is 10.

-nt, --no-trunc

Do not truncate long tool descriptions.

Default: False

-e, --exact

Only return results containing the exact query.

Default: False


Python API¶

boutiques.search(*params)

Refer to the Command-line tool section above

Next Previous

© Copyright 2019, https://github.com/boutiques/boutiques/

Built with Sphinx using a theme provided by Read the Docs.