"Keep your env.sample up to date when using django-environ", a tool and pre-commit hook.
MIT License
Keep your env.sample up to date when using django-environ
ENV_DEFAULTS
variable, in a separate python file named environment_defaults.py
(exactly this file name)# environment_defaults.py
ENV_DEFAULTS = dict(
VARIABLE_WITH_DEFAULT_VALUE=(str, "default value"),
VARIABLE_WITHOUT_DEFAULT_VALUE=str,
)
Env
with ENV_DEFAULTS
on your Django settings file# settings.py
from environ import Env
from environment_defaults import ENV_DEFAULTS
env = Env(**ENV_DEFAULTS)
env("VAR_NAME")
instead of env.str("VAR_NAME")
# settings.py
value = env("VARIABLE_WITH_DEFAULT_VALUE")
value = env("VARIABLE_WITHOUT_DEFAULT_VALUE")
env.sample
gets updated on each commitrepos:
- repo: https://github.com/EnriqueSoria/update-django-environ-sample
rev: 'vX.X.X' # Pick a release version
hooks:
- id: update-django-environ-sample
args: [ "-p", "myapp/" ] # Path where your environment_defaults.py is located