YouConfigMe helps you manage config in a pythonic way
Project description
YouConfigMe
YouConfigMe helps you manage config in a pythonic way.
Core ideas
Explicit is better than implicit
There are several ways to define configuration variables, with different levels of explicitness. I prefer to go as close as possible to the Twelve Factor App guide since it's what most people expect anyways.
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 int
.
Sections are good
Config sections are a good thing: separate your config vars under reasonable namespaces.
Motivation
The main motivation for youconfigme to exist is that most simple config libraries do not take sections into account. And it bugs me greatly.
Install
Clone this repo, and install it.
pip install .
Or from PyPI.
pip install YouConfigMe
Development
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:
pre-commit install
This will install several code formatting tools and set them up to run before commits. Also, it will run tests before pushing.
You might find nox
quite useful to run tests and ensure linting is as expected.
Docs
The docs are updated on pushed tags using GitHub Actions.
Version bumping
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
The tests
folder contains several tests that run using pytest
that should give you an idea of how to use this.
Config discovery
The preferred order should be:
- Environment variables
- Config file
- Default value
Quickstart
Assume you have an .ini
file at the root of your project that looks like this:
[a]
key1=1
key2=2
key7=7
[b]
key3=3
key4=4
You can use it like this:
from youconfigme import AutoConfig
import os
os.environ["A_KEY4"] = "key4value"
os.environ["A_KEY7"] = "key7value"
config = AutoConfig()
print(config.a.key1()) # returns '1'
print(config.a.key1(cast=int)) # returns 1
print(config.a.key2(default='default2val')) # returns '2'
print(config.a.key3()) # raises ConfigItemNotFound
print(config.a.key3(default='key3value')) # return 'key3value'
print(config.a.key4()) # returns 'key4value'
print(config.a.key7()) # returns 'key7value'
Since version 0.9.0
, YCM supports toml
files as well.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for youconfigme-0.10.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2de66856b15b9172a79a27203bc8aee51c3c759df853cbfa164a67356b0f777c |
|
MD5 | 726e0171addc3a023b983fcaa954409e |
|
BLAKE2b-256 | baeb766440007f5d4dd9613ace9fa15cf71bb8e711b95f5767caea891730dc59 |