# Ensembl Python general-purpose utils
[](https://github.com/Ensembl/ensembl-utils/blob/main/LICENSE)
[](https://ensembl.github.io/ensembl-utils/coverage)
[](https://github.com/Ensembl/ensembl-utils/actions/workflows/ci.yml)
[](https://pypi.org/project/ensembl-utils)
Centralise generic Python utils used by other projects 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 tool, e.g.
```bash
pip install ensembl-utils
```
### Quick usage
Besides the standard `import ensembl.utils`, this library also provides some useful command line scripts:
- `extract_file` - to easily extract archive files in different formats
Furthermore, `ensembl-utils` also has a [`pytest`](https://docs.pytest.org/) plugin with some useful functionalities to ease your unit testing. You can enable it by adding it explicitly when running pytest:
```bash
pytest -p ensembl.utils.plugin ...
```
Or adding the following line to your `conftest.py`:
```python
pytest_plugins = ("ensembl.utils.plugin",)
```
## Dependencies
This repository has been developed to support [SQLAlchemy](https://www.sqlalchemy.org) version 1.4 (1.4.45 or later, to ensure "future-compatibility") as well as version 2.0+.
Raw data
{
"_id": null,
"home_page": null,
"name": "ensembl-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ensembl, python, utils",
"author": null,
"author_email": "Ensembl <dev@ensembl.org>",
"download_url": "https://files.pythonhosted.org/packages/d7/89/1428f7267d457a5d21186dfe1f09a6ed895cab484531cfc3dbdae8bfd020/ensembl_utils-0.5.1.tar.gz",
"platform": null,
"description": "# Ensembl Python general-purpose utils\n\n[](https://github.com/Ensembl/ensembl-utils/blob/main/LICENSE)\n[](https://ensembl.github.io/ensembl-utils/coverage)\n[](https://github.com/Ensembl/ensembl-utils/actions/workflows/ci.yml)\n[](https://pypi.org/project/ensembl-utils)\n\nCentralise generic Python utils used by other projects within Ensembl design to facilitate frequent tasks such as input file path checks, archive files IO manipulation or logging setup, among others.\n\nFor more information, please consult this repository's [GitHub pages](https://ensembl.github.io/ensembl-utils/).\n\n## Getting Started\n\n### Basic installation\n\nThis 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 tool, e.g.\n```bash\npip install ensembl-utils\n```\n\n### Quick usage\n\nBesides the standard `import ensembl.utils`, this library also provides some useful command line scripts:\n- `extract_file` - to easily extract archive files in different formats\n\nFurthermore, `ensembl-utils` also has a [`pytest`](https://docs.pytest.org/) plugin with some useful functionalities to ease your unit testing. You can enable it by adding it explicitly when running pytest:\n```bash\npytest -p ensembl.utils.plugin ...\n```\n\nOr adding the following line to your `conftest.py`:\n```python\npytest_plugins = (\"ensembl.utils.plugin\",)\n```\n\n## Dependencies\n\nThis repository has been developed to support [SQLAlchemy](https://www.sqlalchemy.org) version 1.4 (1.4.45 or later, to ensure \"future-compatibility\") as well as version 2.0+.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Ensembl Python general-purpose utils",
"version": "0.5.1",
"project_urls": {
"Documentation": "https://ensembl.github.io/ensembl-utils/",
"Homepage": "https://www.ensembl.org",
"Issues": "https://github.com/Ensembl/ensembl-utils/issues",
"Repository": "https://github.com/Ensembl/ensembl-utils.git"
},
"split_keywords": [
"ensembl",
" python",
" utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "63069a0be6e7bd8d60eaad32dce88d257286f6d91fe5f927ff4383143665469a",
"md5": "fe1d783f62018c3f3b4b842fc1684387",
"sha256": "689d06c6c73ed7e471e62a3fdaac238987ad4eac7fa22a8d0b30fbd8a8a49404"
},
"downloads": -1,
"filename": "ensembl_utils-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe1d783f62018c3f3b4b842fc1684387",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27092,
"upload_time": "2024-10-07T10:13:32",
"upload_time_iso_8601": "2024-10-07T10:13:32.893245Z",
"url": "https://files.pythonhosted.org/packages/63/06/9a0be6e7bd8d60eaad32dce88d257286f6d91fe5f927ff4383143665469a/ensembl_utils-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7891428f7267d457a5d21186dfe1f09a6ed895cab484531cfc3dbdae8bfd020",
"md5": "404cdba3300b38052034e1ba3e924f12",
"sha256": "613d0f9584993aaacab42379b57b0ccbeac9f9269a99c186dddf84d396bc3c86"
},
"downloads": -1,
"filename": "ensembl_utils-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "404cdba3300b38052034e1ba3e924f12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 175149,
"upload_time": "2024-10-07T10:13:34",
"upload_time_iso_8601": "2024-10-07T10:13:34.018167Z",
"url": "https://files.pythonhosted.org/packages/d7/89/1428f7267d457a5d21186dfe1f09a6ed895cab484531cfc3dbdae8bfd020/ensembl_utils-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 10:13:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ensembl",
"github_project": "ensembl-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ensembl-utils"
}
JSON
