Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

Welcome to django-environ documentation

Release v0.11.2 (What's new?).

django-environ is the Python package that allows you to use Twelve-factor methodology to configure your Django application with environment variables.

Overview

The idea of this package is to unify a lot of packages that make the same stuff: Take a string from os.environ, parse and cast it to some of useful python typed variables. To do that and to use the 12factor approach, some connection strings are expressed as url, so this package can parse it and return a urllib.parse.ParseResult. These strings from os.environ are loaded from a .env file and filled in os.environ with setdefault method, to avoid to overwrite the real environ. A similar approach is used in Two Scoops of Django book and explained in 12factor-django article.

Using django-environ you can stop to make a lot of unversioned settings_*.py to configure your app. See cookiecutter-django for a concrete example on using with a django project.

Feature Support

• Fast and easy multi environment for deploy

• Fill os.environ with .env file variables

• Variables casting

• Url variables exploded to django specific package settings

• Optional support for Docker-style file based config variables (use environ.FileAwareEnv instead of environ.Env)

---

Full Table of Contents

The User Guide

This part of the documentation, which is mostly prose, begins with some background information about django-environ, then focuses on step-by-step instructions for getting the most out of django-environ.

• Installation
  • Requirements
  • Installing django-environ
  • Unstable version
• Quick Start
  • Usage

The Community Guide

This part of the documentation, which is mostly prose, details the django-environ ecosystem and community.

• FAQ
• Supported types
  • environ.Env.dict
  • environ.Env.db_url
  • environ.Env.cache_url
  • environ.Env.search_url
  • environ.Env.email_url
• Tips
  • Docker-style file based variables
  • Using unsafe characters in URLs
  • Smart Casting
  • Multiple redis cache locations
  • Email settings
  • SQLite urls
  • Nested lists
  • Complex dict format
  • Multiline value
  • Proxy value
  • Escape Proxy
  • Reading env files
  • Handling prefixes

• Deprecations
• Changelog

The API Documentation / Guide

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• API Reference
  • The __init__ module
  • The compat module
  • The environ module
  • The fileaware_mapping module

The Contributor Guide

If you want to contribute to the project, this part of the documentation is for you.

• Contributing
  • Bug reports
  • Feature requests
  • Pull requests
  • Resources
• Backers and supporters
  • Sponsors
  • Backers
• License and Credits
  • Credits
  • Acknowledgments

Support

Should you have any question, any remark, or if you find a bug, or if there is something you can’t do with the django-environ, please open an issue.

Project Information

django-environ is released under the MIT / X11 License, its documentation lives at Read the Docs, the code on GitHub, and the latest release on PyPI.

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 to django-environ you’re most welcome!