genomepy
  • Home
  • Installation
  • Command line documentation
  • Python API documentation (core)
  • Python API documentation (full)
    • genomepy.annotation
    • genomepy.argparse_support
    • genomepy.caching
    • genomepy.cli
    • genomepy.config
    • genomepy.exceptions
    • genomepy.files
    • genomepy.functions
    • genomepy.genome
    • genomepy.online
    • genomepy.plugins
    • genomepy.providers
      • genomepy.providers.create
      • genomepy.providers.list_online_providers
      • genomepy.providers.list_providers
      • genomepy.providers.map_locations
      • genomepy.providers.online_providers
      • genomepy.providers.search
        • search()
      • genomepy.providers.Provider
      • genomepy.providers.base
      • genomepy.providers.ensembl
      • genomepy.providers.gencode
      • genomepy.providers.local
      • genomepy.providers.ncbi
      • genomepy.providers.ucsc
      • genomepy.providers.url
    • genomepy.seq
    • genomepy.utils
  • Configuration
  • FAQ
  • About
genomepy
  • genomepy
  • genomepy.providers
  • genomepy.providers.search
  • Edit on GitHub

genomepy.providers.search

genomepy.providers.search(term: str, provider: str = None, exact=False, size=False)

Search for term in genome names and descriptions (if term contains text. Case-insensitive), assembly accession IDs (if term starts with GCA_ or GCF_), or taxonomy IDs (if term is a number).

If provider is specified, search only that specific provider, else search all providers.

Note: exact accession ID search on UCSC may return different patch levels.

Parameters
  • term (str, int) – Search term, case-insensitive, allows regex.

  • provider (str , optional) – Only search the specified provider (faster).

  • exact (bool, optional) – term must be an exact match

  • size (bool, optional) – Show absolute genome size.

Yields

list – genome name, provider and metadata

Previous Next

© Copyright Siebren Frölich, Maarten van der Sande, Tilman Schäfers and Simon van Heeringen. Last updated on 2025-05-14, 13:24 (UTC).

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