API reference¶
The API reference is generated from the docstrings of the package.
pymetadata¶
Top level modules.
| module | description |
|---|---|
| cache | Caching of the web service responses |
| console | Shared rich console |
| log | Logging of the package |
| omex | COMBINE archive (OMEX) support |
pymetadata.core¶
Core data structures: annotations with their qualifiers, creators and cross references.
| module | description |
|---|---|
| core.annotation | MIRIAM annotations |
| core.creator | Creator information for models and archives |
| core.miriam | MIRIAM qualifiers |
| core.xref | Cross references to database entries |
pymetadata.webservices¶
The services queried for the information which does not ship with the package. They share one session and the cache.
| module | description |
|---|---|
| webservices.chebi | Substance information from ChEBI |
| webservices.ols | Lookup of ontology terms in the Ontology Lookup Service |
| webservices.registry | The identifiers.org registry |
| webservices.unichem | Substance cross references from UniChem |
| webservices.webservice | The shared HTTP session |
pymetadata.ontologies¶
The ontology terms of SBO, KISAO and PBPKO, see Annotations. The generated modules declare one attribute per ontology term and are not part of the reference, the behaviour of a term is in term.
| module | description |
|---|---|
| ontologies.term | Ontology terms and the base class of the enums |