# hya
<p align="center">
<a href="https://github.com/durandtibo/hya/actions">
<img alt="CI" src="https://github.com/durandtibo/hya/workflows/CI/badge.svg">
</a>
<a href="https://durandtibo.github.io/hya/">
<img alt="Documentation" src="https://github.com/durandtibo/hya/workflows/Documentation/badge.svg">
</a>
<a href="https://github.com/durandtibo/hya/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/hya/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/hya/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/hya/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/hya">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/hya/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/hya/maintainability">
<img src="https://api.codeclimate.com/v1/badges/372b4c4212452ab0b0ad/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/hya/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/372b4c4212452ab0b0ad/test_coverage" />
</a>
<br/>
<a href="https://github.com/psf/black">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings">
<img alt="Doc style: google" src="https://img.shields.io/badge/%20style-google-3666d6.svg">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://github.com/guilatrova/tryceratops">
<img alt="Doc style: google" src="https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black">
</a>
<br/>
<a href="https://pypi.org/project/hya/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/hya">
</a>
<a href="https://pypi.org/project/hya/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/hya.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/hya">
</a>
<br/>
<a href="https://pepy.tech/project/hya">
<img alt="Downloads" src="https://static.pepy.tech/badge/hya">
</a>
<a href="https://pepy.tech/project/hya">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/hya/month">
</a>
<br/>
</p>
## Overview
`hya` is a library of custom [OmegaConf](https://github.com/omry/omegaconf) resolvers.
`hya` is designed to be used with [Hydra](https://github.com/facebookresearch/hydra).
The resolvers can be easily registered in your python project by adding the following lines:
```python
from hya import register_resolvers
register_resolvers()
```
- [Documentation](https://durandtibo.github.io/hya/)
- [Installation](#installation)
- [Contributing](#contributing)
- [API stability](#api-stability)
- [License](#license)
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`hya` can be installed from pip using the following command:
```shell
pip install hya
```
To make the package as slim as possible, only the minimal packages required to use `hya` are
installed.
To include all the packages, you can use the following command:
```shell
pip install hya[all]
```
Please check the [get started page](https://durandtibo.github.io/hya/get_started) to see how to
install only some specific packages or other alternatives to install the library.
The following is the corresponding `hya` versions and tested dependencies.
| `hya` | `omegaconf` | `braceexpand`<sup>*</sup> | `numpy`<sup>*</sup> | `torch`<sup>*</sup> | `python` |
|---------|--------------|---------------------------|---------------------|---------------------|---------------|
| `main` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | `>=1.21,<2.0` | `>=1.10,<2.2` | `>=3.9,<3.13` |
| `0.2.0` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | `>=1.21,<2.0` | `>=1.10,<3.0` | `>=3.9,<3.13` |
| `0.1.3` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.13` |
| `0.1.2` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.13` |
| `0.1.1` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.12` |
| `0.1.0` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.12` |
<sup>*</sup> indicates an optional dependency
<details>
<summary>older versions</summary>
| `hya` | `omegaconf` | `braceexpand`<sup>*</sup> | `torch`<sup>*</sup> | `python` |
|----------|--------------|---------------------------|---------------------|---------------|
| `0.0.14` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | `>=1.10,<2.2` | `>=3.9,<3.12` |
| `0.0.13` | `>=2.1,<3.0` | | `>=1.10,<2.1` | `>=3.9,<3.12` |
| `0.0.12` | `>=2.1,<3.0` | | `>=1.10,<2.1` | `>=3.9,<3.12` |
</details>
## Contributing
Please check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## API stability
:warning: While `hya` is in development stage, no API is guaranteed to be stable from one
release to the next.
In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.
In practice, this means that upgrading `hya` to a new version will possibly break any code that
was using the old version of `hya`.
## License
`hya` is licensed under BSD 3-Clause "New" or "Revised" license available in [LICENSE](LICENSE)
file.
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/hya",
"name": "hya",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.13",
"maintainer_email": "",
"keywords": "omegaconf,resolver",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/22/865b49ab31458041922e074f88b51a030524d685d5b4024f0e538eb5b766/hya-0.2.1.tar.gz",
"platform": null,
"description": "# hya\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/hya/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/hya/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/hya/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/hya/workflows/Documentation/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/hya/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/hya/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/hya/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/hya/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/hya\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/hya/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/hya/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/372b4c4212452ab0b0ad/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/hya/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/372b4c4212452ab0b0ad/test_coverage\" />\n </a>\n <br/>\n <a href=\"https://github.com/psf/black\">\n <img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n </a>\n <a href=\"https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/%20style-google-3666d6.svg\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://github.com/guilatrova/tryceratops\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black\">\n </a>\n <br/>\n <a href=\"https://pypi.org/project/hya/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/hya\">\n </a>\n <a href=\"https://pypi.org/project/hya/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/hya.svg\">\n </a>\n <a href=\"https://opensource.org/licenses/BSD-3-Clause\">\n <img alt=\"BSD-3-Clause\" src=\"https://img.shields.io/pypi/l/hya\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/hya\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/hya\">\n </a>\n <a href=\"https://pepy.tech/project/hya\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/hya/month\">\n </a>\n <br/>\n</p>\n\n## Overview\n\n`hya` is a library of custom [OmegaConf](https://github.com/omry/omegaconf) resolvers.\n`hya` is designed to be used with [Hydra](https://github.com/facebookresearch/hydra).\nThe resolvers can be easily registered in your python project by adding the following lines:\n\n```python\nfrom hya import register_resolvers\n\nregister_resolvers()\n```\n\n- [Documentation](https://durandtibo.github.io/hya/)\n- [Installation](#installation)\n- [Contributing](#contributing)\n- [API stability](#api-stability)\n- [License](#license)\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`hya` can be installed from pip using the following command:\n\n```shell\npip install hya\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `hya` are\ninstalled.\nTo include all the packages, you can use the following command:\n\n```shell\npip install hya[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/hya/get_started) to see how to\ninstall only some specific packages or other alternatives to install the library.\nThe following is the corresponding `hya` versions and tested dependencies.\n\n| `hya` | `omegaconf` | `braceexpand`<sup>*</sup> | `numpy`<sup>*</sup> | `torch`<sup>*</sup> | `python` |\n|---------|--------------|---------------------------|---------------------|---------------------|---------------|\n| `main` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | `>=1.21,<2.0` | `>=1.10,<2.2` | `>=3.9,<3.13` |\n| `0.2.0` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | `>=1.21,<2.0` | `>=1.10,<3.0` | `>=3.9,<3.13` |\n| `0.1.3` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.13` |\n| `0.1.2` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.13` |\n| `0.1.1` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.12` |\n| `0.1.0` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | | `>=1.10,<2.2` | `>=3.9,<3.12` |\n\n<sup>*</sup> indicates an optional dependency\n\n<details>\n <summary>older versions</summary>\n\n| `hya` | `omegaconf` | `braceexpand`<sup>*</sup> | `torch`<sup>*</sup> | `python` |\n|----------|--------------|---------------------------|---------------------|---------------|\n| `0.0.14` | `>=2.1,<3.0` | `>=0.1.7,<0.2.0` | `>=1.10,<2.2` | `>=3.9,<3.12` |\n| `0.0.13` | `>=2.1,<3.0` | | `>=1.10,<2.1` | `>=3.9,<3.12` |\n| `0.0.12` | `>=2.1,<3.0` | | `>=1.10,<2.1` | `>=3.9,<3.12` |\n\n</details>\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## API stability\n\n:warning: While `hya` is in development stage, no API is guaranteed to be stable from one\nrelease to the next.\nIn fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.\nIn practice, this means that upgrading `hya` to a new version will possibly break any code that\nwas using the old version of `hya`.\n\n## License\n\n`hya` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available in [LICENSE](LICENSE)\nfile.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A library of custom OmegaConf resolvers",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/durandtibo/hya",
"Repository": "https://github.com/durandtibo/hya"
},
"split_keywords": [
"omegaconf",
"resolver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2eeb597a63b1eb43acbebc077c56b56a914961057d38f0a641bdbefff62319e2",
"md5": "8afcaf5a4ebcfa3b89d0982afb91987c",
"sha256": "5bb1fd0ad0fca7c0284ce08e3f3ddde45997b93b17e9f2c5897e61318ac23019"
},
"downloads": -1,
"filename": "hya-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8afcaf5a4ebcfa3b89d0982afb91987c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.13",
"size": 10239,
"upload_time": "2024-02-03T22:53:20",
"upload_time_iso_8601": "2024-02-03T22:53:20.307756Z",
"url": "https://files.pythonhosted.org/packages/2e/eb/597a63b1eb43acbebc077c56b56a914961057d38f0a641bdbefff62319e2/hya-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba22865b49ab31458041922e074f88b51a030524d685d5b4024f0e538eb5b766",
"md5": "1451f640bf6db67e68b33af1ea6cd5a0",
"sha256": "3a34d0426cf9cfa669270cd95a014ac97108bea46498ccb2e1d75eda2bae35a4"
},
"downloads": -1,
"filename": "hya-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "1451f640bf6db67e68b33af1ea6cd5a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.13",
"size": 11494,
"upload_time": "2024-02-03T22:53:22",
"upload_time_iso_8601": "2024-02-03T22:53:22.099761Z",
"url": "https://files.pythonhosted.org/packages/ba/22/865b49ab31458041922e074f88b51a030524d685d5b4024f0e538eb5b766/hya-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 22:53:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "hya",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hya"
}
JSON
