# :bear: bearface :bear:
<p align="center">
<a href="https://github.com/durandtibo/bearface/actions">
<img alt="CI" src="https://github.com/durandtibo/bearface/workflows/CI/badge.svg?event=push&branch=main">
</a>
<a href="https://pypi.org/project/bearface/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/bearface">
</a>
<a href="https://pypi.org/project/bearface/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/bearface.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/bearface">
</a>
<a href="https://codecov.io/gh/durandtibo/bearface">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/bearface/branch/main/graph/badge.svg">
</a>
<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>
<br/>
</p>
## Overview
`bearface` is a library of custom [OmegaConf](https://github.com/omry/omegaconf) resolvers.
The resolvers can be easily registered in your python project by adding the following lines:
```python
from bearface import register_resolvers
register_resolvers()
```
- [Documentation](https://durandtibo.github.io/bearface/)
- [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/).
`bearface` can be installed from pip using the following command:
```shell
pip install bearface
```
To make the package as slim as possible, only the minimal packages required to use `bearface` are
installed.
To include all the packages, you can use the following command:
```shell
pip install bearface[all]
```
Please check the [get started page](https://durandtibo.github.io/bearface/get_started) to see how to
install only some specific packages or other alternatives to install the library.
## Contributing
Please check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## API stability
:warning: While `bearface` 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 `bearface` to a new version will possibly break any code that
was using the old version of `bearface`.
## License
`bearface` 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/bearface",
"name": "bearface",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "omegaconf,resolver",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/cd/a0/8e2851233cff00ac39a0cc956fdcb86ee5c160cf07ac11a16f4ec7dc1dcd/bearface-0.0.1.tar.gz",
"platform": null,
"description": "# :bear: bearface :bear:\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/bearface/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/bearface/workflows/CI/badge.svg?event=push&branch=main\">\n </a>\n <a href=\"https://pypi.org/project/bearface/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/bearface\">\n </a>\n <a href=\"https://pypi.org/project/bearface/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/bearface.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/bearface\">\n </a>\n <a href=\"https://codecov.io/gh/durandtibo/bearface\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/bearface/branch/main/graph/badge.svg\">\n </a>\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 <br/>\n</p>\n\n## Overview\n\n`bearface` is a library of custom [OmegaConf](https://github.com/omry/omegaconf) resolvers.\nThe resolvers can be easily registered in your python project by adding the following lines:\n\n```python\nfrom bearface import register_resolvers\n\nregister_resolvers()\n```\n\n- [Documentation](https://durandtibo.github.io/bearface/)\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`bearface` can be installed from pip using the following command:\n\n```shell\npip install bearface\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `bearface` are\ninstalled.\nTo include all the packages, you can use the following command:\n\n```shell\npip install bearface[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/bearface/get_started) to see how to\ninstall only some specific packages or other alternatives to install the library.\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## API stability\n\n:warning: While `bearface` 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 `bearface` to a new version will possibly break any code that\nwas using the old version of `bearface`.\n\n## License\n\n`bearface` 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.0.1",
"split_keywords": [
"omegaconf",
"resolver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ddb3c5cc088892d57bdaf38930a99f4adbfebf4961c4adcbd596c759eabe730",
"md5": "9805cfe533a5f3063d111961ae7ba23b",
"sha256": "c280175c8cf8c23f46eb0ff030ed2ad5204fa1374d32f304e64f26653ce0e88e"
},
"downloads": -1,
"filename": "bearface-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9805cfe533a5f3063d111961ae7ba23b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 6283,
"upload_time": "2023-01-07T05:57:17",
"upload_time_iso_8601": "2023-01-07T05:57:17.055268Z",
"url": "https://files.pythonhosted.org/packages/8d/db/3c5cc088892d57bdaf38930a99f4adbfebf4961c4adcbd596c759eabe730/bearface-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cda08e2851233cff00ac39a0cc956fdcb86ee5c160cf07ac11a16f4ec7dc1dcd",
"md5": "9851bce2f908c0955b2f5ae68b7624b2",
"sha256": "1ef1108a7b9023e87d7f8afc09065cf339f4f185ae3a0eb6217cb53e0daa0844"
},
"downloads": -1,
"filename": "bearface-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9851bce2f908c0955b2f5ae68b7624b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 6136,
"upload_time": "2023-01-07T05:57:18",
"upload_time_iso_8601": "2023-01-07T05:57:18.113857Z",
"url": "https://files.pythonhosted.org/packages/cd/a0/8e2851233cff00ac39a0cc956fdcb86ee5c160cf07ac11a16f4ec7dc1dcd/bearface-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-07 05:57:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "durandtibo",
"github_project": "bearface",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bearface"
}
JSON
