README.md

dabeplech

Light library to perform requests to different bioinformatics APIs. This library also contains models description (thanks to pydantic). It allows automatic documentation of the responses from API that are initially not described.

Please have a look at our Documentation for more information.

List of supported services

List of supported services is listed in the documentation.

Install

Latest published version:

pip install dabeplech

Basic usage

from dabeplech import KEGGAPI

api = KEGGAPI()
kegg_entry = api.get("K00135")
print(kegg_entry.names)
# OUTPUT: ['gabD']

---

Test endpoints

Status of different endpoints can be test with api_status.py script from tests directory.

If the test works, you will get some green output. Do not be surprised if you get ERROR in green, it means it is expected.

---

Development

Packaging and organization of the library is done using Poetry.

In brief after installing poetry, from the repository directory, just run:

poetry install

Run all quality checks and tests locally

You can run all quality checks and unit tests locally.

To list all available commands:

poetry run inv --list
# for instance
poetry run inv quality.all  # Run all quality tests

---

Contributions

All contributions are welcome. Please have a look at our Contribution Guide.