Metadata-Version: 2.1
Name: bionty-base
Version: 0.37.2
Summary: Bionty.
Author-email: Lamin Labs <laminlabs@gmail.com>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pronto>=2.5.4, <2.5.6
Requires-Dist: lamin_utils>=0.12.0
Requires-Dist: pyyaml
Requires-Dist: pandas
Requires-Dist: pyarrow
Requires-Dist: botocore
Requires-Dist: rich
Requires-Dist: filelock
Requires-Dist: rapidfuzz
Requires-Dist: requests
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pytest>=6.0 ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: laminci ; extra == "dev"
Requires-Dist: nbproject-test ; extra == "dev"
Requires-Dist: bioregistry ; extra == "dev"
Requires-Dist: sqlalchemy ; extra == "dev"
Requires-Dist: mysqlclient ; extra == "dev"
Requires-Dist: mysql-connector-python ; extra == "dev"
Project-URL: Home, https://github.com/laminlabs/bionty-base
Provides-Extra: dev

[![codecov](https://codecov.io/gh/laminlabs/bionty-base/graph/badge.svg?token=8292E0S0Z7)](https://codecov.io/gh/laminlabs/bionty-base)
[![pypi](https://img.shields.io/pypi/v/bionty-base?color=blue&label=pypi%20package)](https://pypi.org/project/bionty-base)

# `bionty-base`

Access public biological ontologies.

- User docs: [here](https://lamin.ai/docs/public-ontologies)
- Developer docs: [here](https://lamin.ai/docs/bionty-base)

## Installation

Bionty-base is a Python package available for ![pyversions](https://img.shields.io/pypi/pyversions/bionty-base)

```shell
pip install bionty-base
```

## Entities

- `Gene` - [Ensembl](https://ensembl.org), [NCBI Gene](https://www.ncbi.nlm.nih.gov/gene)
- `Protein` - [Uniprot](https://www.uniprot.org/)
- `Organism` - [Ensembl Species](https://useast.ensembl.org/info/about/species.html). [NCBI Taxonomy](https://www.ncbi.nlm.nih.gov/taxonomy)
- `CellLine` - [Cell Line Ontology](https://github.com/CLO-ontology/CLO)
- `CellType` - [Cell Ontology](https://obophenotype.github.io/cell-ontology)
- `CellMarker` - [CellMarker](http://xteam.xbio.top/CellMarker)
- `Tissue` - [Uberon](http://obophenotype.github.io/uberon)
- `Disease` - [Mondo](https://mondo.monarchinitiative.org), [Human Disease](https://disease-ontology.org), [ICD](https://www.who.int/standards/classifications/classification-of-diseases)
- `Phenotype` - [Human Phenotype](https://hpo.jax.org/app), [Phecodes](https://phewascatalog.org/phecodes_icd10), [PATO](https://github.com/pato-ontology/pato), [Mammalian Phenotype](http://obofoundry.org/ontology/mp.html), [Zebrafish Phenotype](http://obofoundry.org/ontology/zp.html)
- `Pathway` - [Gene Ontology](https://bioportal.bioontology.org/ontologies/GO), [Pathway Ontology](https://bioportal.bioontology.org/ontologies/PW)
- `ExperimentalFactor` - [Experimental Factor Ontology](https://www.ebi.ac.uk/ols/ontologies/efo)
- `DevelopmentalStage` - [Human Developmental Stages](https://github.com/obophenotype/developmental-stage-ontologies/wiki/HsapDv), [Mouse Developmental Stages](https://github.com/obophenotype/developmental-stage-ontologies/wiki/MmusDv)
- `Drug` - [Drug Ontology](https://bioportal.bioontology.org/ontologies/DRON)
- `Ethnicity` - [Human Ancestry Ontology](https://github.com/EBISPOT/hancestro)
- `BFXPipeline` - largely based on [nf-core](https://nf-co.re)
- `BioSample` - [NCBI BioSample attributes](https://www.ncbi.nlm.nih.gov/biosample/docs/attributes)

Check out [sources.yaml](https://github.com/laminlabs/bionty-base/blob/main/bionty_base/sources/sources.yaml) for details.

Didn't see your favorite source or version? Bionty is [extendable](https://lamin.ai/docs/bionty-base/guide/extend)!

## Entity versions

```python
import bionty_base as bt

# display currently used sources
bt.display_currently_used_sources()

# display all managed sources
bt.display_available_sources()

# local yaml file specifying all managed sources
bt.LOCAL_SOURCES

# access to the Mondo ontology
disease = bt.Disease(source="mondo")

# access to the Human Disease ontology
disease = bt.Disease(source="doid", version="2023-01-30")
```

