How to install this repository

This Python library only requires Python 3.10+ to work. However, it is likely that most modules and functionalities will be compatible with Python 3.9 as well.

Basic installation

This library is publicly available in PyPI so it can be easily installed with your favourite Python dependency and packaging management tool, e.g.

pip install ensembl-utils

Development-oriented installation

If you want to install this library in editable mode, we suggest you to do so via Python's virtual environment module (venv):

python -m venv <VIRTUAL_ENVIRONMENT_NAME>
source <VIRTUAL_ENVIRONMENT_NAME>/bin/activate
git clone https://github.com/Ensembl/ensembl-utils.git
cd ensembl-utils
pip install -e .[cicd,docs]

Note that the documentation (docs tag) is generated using mkdocs. For full information visit mkdocs.org.