Metadata-Version: 2.1
Name: ensembl-utils
Version: 0.1.2
Summary: Ensembl Python general-purpose utils
Author-email: Ensembl <dev@ensembl.org>
License: Apache License 2.0
Project-URL: homepage, https://www.ensembl.org
Project-URL: documentation, https://ensembl.github.io/ensembl-utils/
Project-URL: repository, https://github.com/Ensembl/ensembl-utils
Keywords: ensembl,python,utils
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: python-dotenv >=0.19.2
Requires-Dist: pyyaml ~=6.0
Requires-Dist: requests >=2.22.0
Requires-Dist: sqlalchemy ~=1.4.0
Provides-Extra: build
Requires-Dist: build ; extra == 'build'
Requires-Dist: setuptools ; extra == 'build'
Requires-Dist: setuptools-scm ; extra == 'build'
Requires-Dist: wheel ; extra == 'build'
Provides-Extra: cicd
Requires-Dist: black ; extra == 'cicd'
Requires-Dist: coverage ; extra == 'cicd'
Requires-Dist: genbadge[coverage] ; extra == 'cicd'
Requires-Dist: mypy ; extra == 'cicd'
Requires-Dist: pylint ; extra == 'cicd'
Requires-Dist: pytest ; extra == 'cicd'
Requires-Dist: pytest-dependency ; extra == 'cicd'
Requires-Dist: requests-mock >=1.8.0 ; extra == 'cicd'
Requires-Dist: types-pyyaml ; extra == 'cicd'
Requires-Dist: types-requests ; extra == 'cicd'
Provides-Extra: docs
Requires-Dist: mkdocs >=1.5.3 ; extra == 'docs'
Requires-Dist: mkdocs-autorefs ; extra == 'docs'
Requires-Dist: mkdocs-coverage ; extra == 'docs'
Requires-Dist: mkdocs-gen-files ; extra == 'docs'
Requires-Dist: mkdocs-literate-nav ; extra == 'docs'
Requires-Dist: mkdocs-material ; extra == 'docs'
Requires-Dist: mkdocs-material-extensions ; extra == 'docs'
Requires-Dist: mkdocs-section-index ; extra == 'docs'
Requires-Dist: mkdocstrings ; extra == 'docs'
Requires-Dist: mkdocstrings-python ; extra == 'docs'

# Ensembl Python general-purpose utils

[![License](https://img.shields.io/badge/license-Apache_2.0-blue.svg)](https://github.com/Ensembl/ensembl-utils/blob/main/LICENSE)
[![Coverage](https://ensembl.github.io/ensembl-utils/coverage/coverage-badge.svg)](https://ensembl.github.io/ensembl-utils/coverage)
[![CI](https://github.com/Ensembl/ensembl-utils/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Ensembl/ensembl-utils/actions/workflows/ci.yml)

Centralise generic Python utils used by other project within Ensembl design to facilitate frequent tasks such as input file path checks, archive files IO manipulation or logging setup, among others.

For more information, please consult this repository's [GitHub pages](https://ensembl.github.io/ensembl-utils/).

## Getting Started

### Basic installation

This library is publicly available in [PyPI](https://pypi.org/project/ensembl-utils/) so it can be easily installed with your favourite Python dependency and packaging management, e.g.
```bash
pip install ensembl-utils
```

### Installing the development environment (with Python `venv`)

If you want to install this library in editable mode, we suggest you to do so via Python's virtual environment module ([venv](https://docs.python.org/3/library/venv.html)):
```bash
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]
```
