Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnoortheen/dynamic-conf
Declarative way to manage configuration variables separated from source.
https://github.com/jnoortheen/dynamic-conf
configuration-files configuration-management django dotenv python
Last synced: 2 months ago
JSON representation
Declarative way to manage configuration variables separated from source.
- Host: GitHub
- URL: https://github.com/jnoortheen/dynamic-conf
- Owner: jnoortheen
- License: mit
- Created: 2019-10-10T16:19:16.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T08:33:34.000Z (9 months ago)
- Last Synced: 2024-09-18T03:53:42.989Z (3 months ago)
- Topics: configuration-files, configuration-management, django, dotenv, python
- Language: Python
- Homepage:
- Size: 64.5 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dynamic-config
Project configuration variables are declared beforehand and inferred from environment variables or configuration files. Useful while developing and deploying( CI/CD) django web-apps
-------
[](https://pypi.python.org/pypi/dynamic-conf)
[](https://pypi.org/project/dynamic-conf/)
-------
# Install
```
pip install dynamic-conf
```
# Features
- supports `.env` or `.py` files
- supports casting with type annotations
- You also don't need to include a sample file. Since the `Config` object would be able to generate `.env.py` itself.
- It also loads Configuration variables from environment variables.
The order of preference is `env variables` > `env.py`
- Attributes are lazily evaluated.
# Getting Started
- You need to subclass the `Config` class.
- The config file should define all the variables needed for a project.
```python
# project/conf.py
from dynamic_conf import Config, REQUIRED
class CONFIG(Config):
"""singleton to be used for configuring from os.environ and env.py"""
# default settings
ENV = "prod" # optional field with a default value
DB_NAME = "db"
DB_HOST = "127.0.0.1"
DB_USER = "postgres"
DB_PASS = None # even None could be given as default value
SECRET_KEY:str # Python 3 only
AN_SECRET_KEY = REQUIRED # Python 2 & 3
```
- to create `project/env.py` just run with the path to CONFIG class's module
```shell script
# you could pass environment variables or set already with export
env DB_PASS='123' dynamic-conf project/conf.py
dynamic-conf project/conf.py DB_USER='user-1' DB_PASS='123' # pass as list of key-value pair
#to filter environment variables with a prefix
env VARS_PREFIX="PROD_" dynamic-conf project/conf.py PROD_DB_USER="user-2"
```
# Usage
- To use the config simply import and use particular attribute
```python
# project/settings.py
from conf import CONFIG
DATABASES = {
"default": {
"ENGINE": "django.contrib.gis.db.backends.postgis",
"HOST": CONFIG.DB_HOST,
"NAME": CONFIG.DB_NAME,
"USER": CONFIG.DB_USER,
"PASSWORD": CONFIG.DB_PASSWORD,
"PORT": "5432",
}
}
```