Configus - a declarative spec for configuration
Project description
Configus - a declarative contract for configuration
### Instalation
```
pip install configus
```
### Features
- [x] Unified spec for process config
- [x] Strict validation of config, no more trailing whitespaces or runtime panics from malphormed uri's
- [x] Support parametrization from env variables and cli arguments at the same time.
- [x] The same param could passed as `export DEBUG=on` or `--debug=on`
- [x] Auto load of `.env` file
- [x] Easy to mock for unit tests
### Usage
Let start with a simple spec that our requires `debug`, `version` and `secret_cookie` configuration params
```python
# app.py
from configus import config, trafaret as t
if __name__ == '__main__':
# Describes shape of the data params which will be taken either from env, cli args or envfile.
schema = t.Dict(DEBUG=t.StrBool, VERSION=t.Float, SECRET_COOKIE=t.String)
env_vars = config(schema=schema)
assert env_vars == {'DEBUG': True, VERSION: 0.1, SECRET_COOKIE=<......>}
```
Once schema defined we can pass variables throw env
```shell
DEBUG=1 VERSION=1.0 SECRET_COOKIE=yo python app.py
```
Cmd flags
```shell
python app.py --debug=1 version=1.0
```
Or even both
```shell
export VERSION=1.0
export SECRET_COOKIE=yo
python app.py --debug=2
```
### Instalation
```
pip install configus
```
### Features
- [x] Unified spec for process config
- [x] Strict validation of config, no more trailing whitespaces or runtime panics from malphormed uri's
- [x] Support parametrization from env variables and cli arguments at the same time.
- [x] The same param could passed as `export DEBUG=on` or `--debug=on`
- [x] Auto load of `.env` file
- [x] Easy to mock for unit tests
### Usage
Let start with a simple spec that our requires `debug`, `version` and `secret_cookie` configuration params
```python
# app.py
from configus import config, trafaret as t
if __name__ == '__main__':
# Describes shape of the data params which will be taken either from env, cli args or envfile.
schema = t.Dict(DEBUG=t.StrBool, VERSION=t.Float, SECRET_COOKIE=t.String)
env_vars = config(schema=schema)
assert env_vars == {'DEBUG': True, VERSION: 0.1, SECRET_COOKIE=<......>}
```
Once schema defined we can pass variables throw env
```shell
DEBUG=1 VERSION=1.0 SECRET_COOKIE=yo python app.py
```
Cmd flags
```shell
python app.py --debug=1 version=1.0
```
Or even both
```shell
export VERSION=1.0
export SECRET_COOKIE=yo
python app.py --debug=2
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
configus-0.1.4.tar.gz
(3.1 kB
view details)
File details
Details for the file configus-0.1.4.tar.gz
.
File metadata
- Download URL: configus-0.1.4.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc325fd47f7f9ef28ab03fcb35d4f4d26c3b500bb20e6ab206a59b99d6648041 |
|
MD5 | 1055c53c25047e8b4098569e6b94dd08 |
|
BLAKE2b-256 | 6bede89d2ae969c22e6ce23359ab339fab40f18dc52a667c218ade758912fceb |