:bear: bearface :bear:

Overview

bearface is a library of custom OmegaConf resolvers. The resolvers can be easily registered in your python project by adding the following lines:

from bearface import register_resolvers

register_resolvers()

• Documentation
• Installation
• Contributing
• API stability
• License

Installation

We highly recommend installing a virtual environment. bearface can be installed from pip using the following command:

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:

pip install bearface[all]

Please check the get started page to see how to install only some specific packages or other alternatives to install the library.

Contributing

Please check the instructions in 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 file.