YouConfigMe helps you manage config in a pythonic way
YouConfigMe helps you manage config in a pythonic way.
Explicit is better than implicit
There are several ways to define configuration variables, with different levels of explicitness. From most to less explicit:
- Variable defined in config file
- Variable set as env var
Defaults are reasonable
Sometimes you might need a variable to exist even if it hasn't been defined. So, you should be able to provide defaults.
Types are inherent to the variable
Most of the time, variables are defined as strings, on
.ini files or as env vars. But what if your variable is an
int? You should be able to get it as an
Sections are good
Config sections are a good thing: separate your config vars under reasonable namespaces.
Clone this repo, and install it.
pip install YouConfigMe
Start by cloning the repo/forking it.
You should install YouConfigMe's dev packages to help.
pip install .[dev] pip install .[test]
After that, install the pre-commit hooks:
This will install several code formatting tools and set them up to run before commits. Also, it will run tests before pushing.
To update the docs to the latest changes
cd docs make html
This project uses bump to quickly bump versions.
By default running
bump will bump the patch version. You can bump minor/major versions like so:
bump --minor bump --major
tests folder contains several tests that run using
pytest that should give you an idea of how to use this.
Assume you have an
.ini file at the root of your project that looks like this:
[a] key1=1 key2=2 [b] key3=3 key4=4
You can use it like this:
from youconfigme import AutoConfig, ConfigItemNotFound import os os.environ["A_KEY4"] = "key4value" config = AutoConfig() print(config.a.key1(cast=int)) # returns 1 print(config.a.key2()) # returns '2' print(config.a.key3()) # raises ConfigItemNotFound print(config.a.key3(default='key3value')) # return 'key3value' print(config.a.key4()) # returns 'key4value'
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size youconfigme-0.4.1.tar.gz (5.3 kB)||File type Source||Python version None||Upload date||Hashes View|