This article is intended for engineers who use the Django framework. It gives a deep insight into configuring Django project settings, and the pros and cons of different approaches. In the article you will also find recommendations concerning tools, best practices and architectural solutions, all time-tested and proven by successful projects.
Table of contents:
- Managing Django Settings: Issues
- Setting Configuration: Different Approaches
- 12 Factors
- Setting Structure
- Naming conventions
- Django Settings: Best Practices
Different environments. Usually, you have several environments: local, dev, ci, qa, staging, production, etc. Each environment can have its own specific settings (for example:
DEBUG = True, more verbose logging, additional apps, some mocked data, etc). You need an approach that allows you to keep all these Django setting configurations.
Sensitive data. You have
SECRET_KEY in each Django project. On top of this there can be DB passwords and tokens for third-party APIs like Amazon or Twitter. This data cannot be stored in VCS.
Sharing settings between team members. You need a general approach to eliminate human error when working with the settings. For example, a developer may add a third-party app or some API integration and fail to add specific settings. On large (or even mid-size) projects, this can cause real issues.
Django settings are a Python code. This is a curse and a blessing at the same time. It gives you a lot of flexibility, but can also be a problem – instead of key-value pairs, settings.py can have a very tricky logic.
There is no built-in universal way to configure Django settings without hardcoding them. But books, open-source and work projects provide a lot of recommendations and approaches on how to do it best. Let’s take a brief look at the most popular ones to examine their weaknesses and strengths.
This is the oldest method. I used it when I was configuring a Django project on a production server for the first time. I saw a lot of people use it back in the day, and I still see it now.
The basic idea of this method is to extend all environment-specific settings in the
settings_local.py file, which is ignored by VCS. Here’s an example:
- Secrets not in VCS.
settings_local.pyis not in VCS, so you can lose some of your Django environment settings.
- The Django settings file is a Python code, so
settings_local.pycan have some non-obvious logic.
- You need to have
settings_local.example(in VCS) to share the default configurations for developers.
This is an extension of the previous approach. It allows you to keep all configurations in VCS and to share default settings between developers.
In this case, you make a
settings package with the following file structure:
settings/ ├── __init__.py ├── base.py ├── ci.py ├── local.py ├── staging.py ├── production.py └── qa.py
To run a project with a specific configuration, you need to set an additional parameter:
- All environments are in VCS.
- It’s easy to share settings between developers.
- You need to find a way to handle secret passwords and tokens.
- “Inheritance” of settings can be hard to trace and maintain.
To solve the issue with sensitive data, you can use environment variables.
This is the simplest example using Python
os.environ and it has several issues:
- You need to handle
- You need to convert types manually (see
KeyError, you can write your own custom wrapper. For example:
Also, you can set default values for this wrapper and add type conversion. But actually there is no need to write this wrapper, because you can use a third-party library (we’ll talk about this later).
- Configuration is separated from code.
- Environment parity – you have the same code for all environments.
- No inheritance in settings, and cleaner and more consistent code.
- There is a theoretical grounding for using environment variables – 12 Factors.
- You need to handle sharing default config between developers.
12 Factors is a collection of recommendations on how to build distributed web-apps that will be easy to deploy and scale in the Cloud. It was created by Heroku, a well-known Cloud hosting provider.
As the name suggests, the collection consists of twelve parts:
- Backing services
- Build, release, run
- Port binding
- Dev/prod parity
- Admin processes
Each point describes a recommended way to implement a specific aspect of the project. Some of these points are covered by instruments like Django, Python, pip. Some are covered by design patterns or the infrastructure setup. In the context of this article, we are interested in one part: the Configuration.
Its main rule is to store configuration in the environment. Following this recommendation will give us strict separation of config from code.
You can read more on 12factor.net.
Based on the above, we see that environment variables are the perfect place to store settings.
Now it’s time to talk about the toolkit.
Writing code using
os.environ could be tricky sometimes and require additional effort to handle errors. It’s better to use django-environ instead.
Technically it’s a merge of:
This app gives a well-functioning API for reading values from environment variables or text files, handful type conversion, etc. Let’s look at some examples.
settings.py file before:
settings.py file after:
Instead of splitting settings by environments, you can split them by the source: Django, third- party apps (Celery, DRF, etc.), and your custom settings.
project/ ├── apps/ ├── settings/ │ ├── __init__.py │ ├── djano.py │ ├── project.py │ └── third_party.py └── manage.py
Each module could be done as a package, and you can split it more granularly:
project/ ├── apps/ ├── settings/ │ ├── project │ │ ├── __init__.py │ │ ├── custom_module_foo.py │ │ ├── custom_module_bar.py │ │ └── custom_module_xyz.py │ ├── third_party │ │ ├── __init__.py │ │ ├── celery.py │ │ ├── email.py │ │ └── rest_framework.py │ ├── __init__.py │ └── djano.py └── manage.py
Naming of variables is one of the most complex parts of development. So is naming of settings. We can’t imply on Django or third-party applications, but we can follow these simple rules for our custom (project) settings:
- Give meaningful names to your settings.
- Always use the prefix with the project name for your custom (project) settings.
- Write descriptions for your settings in comments.
MYAWESOMEPROJECT to you real project name.
- Keep settings in environment variables.
- Write default values for production configuration (excluding secret keys and tokens).
- Don’t hardcode sensitive settings, and don’t put them in VCS.
- Split settings into groups: Django, third-party, project.
- Follow naming conventions for custom (project) settings.
The Settings file is a small but very important part of any Django project. If you do it wrong, you’ll have a lot of issues during all phases of development. But if you do it right, it will be a good basis for your project that will allow it to grow and scale in the future.
Using the environment variables approach, you can easily switch from a monolith to microservice architecture, wrap your project in Docker containers, and deploy it in any VPS or Cloud hosting platform such as: Amazon, Google Cloud, or your own Kubernetes cluster.