Package: django-environ
django-environis the Python package that allows you to useTwelve-factor methodologyto configure your
Django application with environment variables.For that, it gives you an easy way to configure Django application using
environment variables obtained from an environment file and provided by the OS:importenvironimportosenv=environ.Env(# set casting, default valueDEBUG=(bool,False))# Set the project base directoryBASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))# Take environment variables from .env fileenviron.Env.read_env(os.path.join(BASE_DIR,'.env'))# False if not in os.environ because of casting aboveDEBUG=env('DEBUG')# Raises Django's ImproperlyConfigured# exception if SECRET_KEY not in os.environSECRET_KEY=env('SECRET_KEY')# Parse database connection url strings# like psql://user:pass@127.0.0.1:8458/dbDATABASES={# read os.environ['DATABASE_URL'] and raises# ImproperlyConfigured exception if not found## The db() method is an alias for db_url().'default':env.db(),# read os.environ['SQLITE_URL']'extra':env.db_url('SQLITE_URL',default='sqlite:////tmp/my-tmp-sqlite.db')}CACHES={# Read os.environ['CACHE_URL'] and raises# ImproperlyConfigured exception if not found.## The cache() method is an alias for cache_url().'default':env.cache(),# read os.environ['REDIS_URL']'redis':env.cache_url('REDIS_URL')}The idea of this package is to unify a lot of packages that make the same stuff:
Take a string fromos.environ, parse and cast it to some of useful python
typed variables. To do that and to use the12factorapproach, some connection strings are expressed as url, so this package can parse
it and return aurllib.parse.ParseResult. These strings fromos.environare loaded from a.envfile and filled inos.environwithsetdefaultmethod, to avoid to overwrite the real environ.
A similar approach is used inTwo Scoops of Djangobook and explained in12factor-djangoarticle.Usingdjango-environyou can stop to make a lot of unversionedsettings_*.pyto configure your app.
Seecookiecutter-djangofor a concrete example on using with a django project.Feature SupportFast and easy multi environment for deployFillos.environwith .env file variablesVariables castingUrl variables exploded to django specific package settingsOptional support for Docker-style file based config variables (useenviron.FileAwareEnvinstead ofenviron.Env)Project Informationdjango-environis released under theMIT / X11 License,
its documentation lives atRead the Docs,
the code onGitHub,
and the latest release onPyPI.It’s rigorously tested on Python 3.6+, and officially supports
Django 1.11, 2.2, 3.0, 3.1, 3.2, 4.0, 4.1 and 4.2.If you’d like to contribute todjango-environyou’re most welcome!SupportShould you have any question, any remark, or if you find a bug, or if there is
something you can’t do with thedjango-environ, pleaseopen an issue.ContributingIf you would like to contribute todjango-environ, please take a look at thecurrent issues.  If there is
a bug or feature that you want but it isn’t listed, make an issue and work on it.Bug reportsBefore raising an issue, please ensure that you are using the latest version
of django-environ.Please provide the following information with your issue to enable us to
respond as quickly as possible.The relevant versions of the packages you are using.The steps to recreate your issue.The full stacktrace if there is an exception.An executable code example where possibleGuidelines for bug reports:Use the GitHub issue search— check if the issue has already been
reported.Check if the issue has been fixed— try to reproduce it using the latestmainordevelopbranch in the repository.Isolate the problem — create a reduced test case and a live example.A good bug report shouldn’t leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What is
your environment? What steps will reproduce the issue? What OS experience the
problem? What would you expect to be the outcome? All these details will help
people to fix any potential bugs.Feature requestsFeature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It’s up toyouto make a strong
case to convince the project’s developers of the merits of this feature. Please
provide as much detail and context as possible.Pull requestsGood pull requests - patches, improvements, new features - are a fantastic
help. They should remain focused in scope and avoid containing unrelated
commits.Follow this process if you’d like your work considered for inclusion in the
project:Check for open issues or open a fresh issue to start a discussion around a
feature idea or a bug.Forkthe repositoryon GitHub to start making your changes to thedevelopbranch
(or branch off of it).Write a test which shows that the bug was fixed or that the feature works as
expected.Send a pull request and bug the maintainer until it gets merged and published.If you are intending to implement a fairly large feature we’d appreciate if you
open an issue with GitHub detailing your use case and intended solution to
discuss how it might impact other work that is in flight.We also appreciate it if you take the time to update and write tests for any
changes you submit.By submitting a patch, you agree to allow the project owner to license your
work under the same license as that used by the project.ResourcesHow to Contribute to Open SourceUsing Pull RequestsWriting good commit messagesRelease Informationv0.11.2 - 1-September-2023FixedRevert “Add variable expansion.” feature
due to#490.Full changelog.Security PolicyReporting a VulnerabilityIf you discover a security vulnerability withindjango-environ, please
send an e-mail to Serghei Iakovlev viaegrep@protonmail.ch. All security
vulnerabilities will be promptly addressed.Creditsdjango-environwas initially created byDaniele Faragliaand currently maintained bySerghei Iakovlev.A full list of contributors can be found inGitHub.AcknowledgmentsThe existence ofdjango-environwould have been impossible without these
projects:rconradharris/envparsejazzband/dj-database-urlmigonzalvar/dj-email-urlghickman/django-cache-urldstufft/dj-search-urljulianwachholz/dj-config-urlnickstenning/honchorconradharris/envparse