mgnipy.emgapi_v2_client.api.genomes package

Contains endpoint functions for accessing the API

Submodules

mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations module

mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations.sync_detailed(accession, *, client)

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeWithAnnotations]

Return type:

Response[GenomeWithAnnotations]

mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations.sync(accession, *, client)

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeWithAnnotations

Return type:

GenomeWithAnnotations | None

async mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations.asyncio_detailed(accession, *, client)

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeWithAnnotations]

Return type:

Response[GenomeWithAnnotations]

async mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations.asyncio(accession, *, client)

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeWithAnnotations

Return type:

GenomeWithAnnotations | None

mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue module

mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue.sync_detailed(catalogue_id, *, client)

Get genome catalogue by ID

Parameters:

• catalogue_id (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeCatalogueDetail]

Return type:

Response[GenomeCatalogueDetail]

mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue.sync(catalogue_id, *, client)

Get genome catalogue by ID

Parameters:

• catalogue_id (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeCatalogueDetail

Return type:

GenomeCatalogueDetail | None

async mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue.asyncio_detailed(catalogue_id, *, client)

Get genome catalogue by ID

Parameters:

• catalogue_id (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeCatalogueDetail]

Return type:

Response[GenomeCatalogueDetail]

async mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue.asyncio(catalogue_id, *, client)

Get genome catalogue by ID

Parameters:

• catalogue_id (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeCatalogueDetail

Return type:

GenomeCatalogueDetail | None

mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes module

mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.sync_detailed(catalogue_id, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

Get genomes within the genome catalogue

Parameters:

• catalogue_id (str )

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeList]

mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.sync(catalogue_id, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

Get genomes within the genome catalogue

Parameters:

• catalogue_id (str )

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeList

Return type:

NinjaPaginationResponseSchemaGenomeList | None

async mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.asyncio_detailed(catalogue_id, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

Get genomes within the genome catalogue

Parameters:

• catalogue_id (str )

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeList]

async mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.asyncio(catalogue_id, *, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

Get genomes within the genome catalogue

Parameters:

• catalogue_id (str )

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeList

Return type:

NinjaPaginationResponseSchemaGenomeList | None

mgnipy.emgapi_v2_client.api.genomes.get_mgnify_genome module

mgnipy.emgapi_v2_client.api.genomes.get_mgnify_genome.sync_detailed(accession, *, client)

Get the detail of a single MGnify Genome

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeDetail]

Return type:

Response[GenomeDetail]

mgnipy.emgapi_v2_client.api.genomes.get_mgnify_genome.sync(accession, *, client)

Get the detail of a single MGnify Genome

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeDetail

Return type:

GenomeDetail | None

async mgnipy.emgapi_v2_client.api.genomes.get_mgnify_genome.asyncio_detailed(accession, *, client)

Get the detail of a single MGnify Genome

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeDetail]

Return type:

Response[GenomeDetail]

async mgnipy.emgapi_v2_client.api.genomes.get_mgnify_genome.asyncio(accession, *, client)

Get the detail of a single MGnify Genome

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• accession (str )

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeDetail

Return type:

GenomeDetail | None

mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues module

mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues.sync_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeCatalogueList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeCatalogueList]

mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues.sync(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeCatalogueList

Return type:

NinjaPaginationResponseSchemaGenomeCatalogueList | None

async mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues.asyncio_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeCatalogueList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeCatalogueList]

async mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues.asyncio(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeCatalogueList

Return type:

NinjaPaginationResponseSchemaGenomeCatalogueList | None

mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes module

mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.sync_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeList]

mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.sync(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeList

Return type:

NinjaPaginationResponseSchemaGenomeList | None

async mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.asyncio_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeList]

async mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.asyncio(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeList

Return type:

NinjaPaginationResponseSchemaGenomeList | None