Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sobolevn/django-split-settings
Organize Django settings into multiple files and directories. Easily override and modify settings. Use wildcards and optional settings files.
https://github.com/sobolevn/django-split-settings
django django-configuration django-settings python python3 settings
Last synced: about 1 month ago
JSON representation
Organize Django settings into multiple files and directories. Easily override and modify settings. Use wildcards and optional settings files.
- Host: GitHub
- URL: https://github.com/sobolevn/django-split-settings
- Owner: wemake-services
- License: bsd-3-clause
- Created: 2013-05-17T06:04:30.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T08:32:27.000Z (about 2 months ago)
- Last Synced: 2024-10-30T13:04:27.599Z (about 1 month ago)
- Topics: django, django-configuration, django-settings, python, python3, settings
- Language: Python
- Homepage: http://django-split-settings.rtfd.io
- Size: 1.57 MB
- Stars: 1,113
- Watchers: 17
- Forks: 67
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-django - django-split-settings - Organize multiple settings files. (Third-Party Packages / Configuration)
- starred-awesome - django-split-settings - Organize Django settings into multiple files and directories. Easily override and modify settings. Use wildcards and optional settings files. (Python)
- -awesome-django - django-split-settings - Organize multiple settings files. (Third-Party Packages / Configuration)
README
---
[](https://wemake.services)
[](https://github.com/wemake-services/django-split-settings/actions/workflows/test.yml)
[](https://codecov.io/gh/sobolevn/django-split-settings)
[](http://django-split-settings.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project/django-split-settings/)
[](https://github.com/wemake-services/wemake-python-styleguide)
Organize Django settings into multiple files and directories. Easily
override and modify settings. Use wildcards in settings file paths
and mark settings files as optional.
Read [this blog post](https://sobolevn.me/2017/04/managing-djangos-settings)
for more information.
Also, check this [example project](https://github.com/wemake-services/wemake-django-template).
## Requirements
While this package will most likely work with the most versions of `django`, we [officially support](https://github.com/sobolevn/django-split-settings/blob/master/.github/workflows/test.yml):
- 4.2
- 5.0
- 5.1
This package has no dependencies itself.
In case you need older `python` / `django` versions support,
then consider using older versions of `django-split-settings`.
## Installation
```bash
pip install django-split-settings
```
## Usage
Replace your existing `settings.py` with a list of components that
make up your Django settings. Preferably create a settings package
that contains all the files.
Here's a minimal example:
```python
from split_settings.tools import optional, include
include(
'components/base.py',
'components/database.py',
optional('local_settings.py')
)
```
In the example, the files `base.py` and `database.py` are included
in that order from the subdirectory called `components/`.
`local_settings.py` in the same directory is included if it exists.
**Note:** The local context is passed on to each file, so each
following file can access and modify the settings declared in the
previous files.
We also made an in-depth [tutorial](https://sobolevn.me/2017/04/managing-djangos-settings).
## Tips and tricks
You can use wildcards in file paths:
```python
include('components/my_app/*.py')
```
Note that files are included in the order that `glob` returns them,
probably in the same order as what `ls -U` would list them. The
files are NOT in alphabetical order.
You can modify common settings in environment settings simply importing them
```python
# local_settings.py
from components.base import INSTALLED_APPS
INSTALLED_APPS += (
'raven.contrib.django.raven_compat',
)
```
## Updating `BASE_DIR`
The `django create-project` command will create a variable in your `settings.py` called `BASE_DIR`, which is often used to locate static files, media files, and templates.
```python
# Created by django create-project
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
STATIC_ROOT = os.path.join(BASE_DIR, "staticfiles/")
MEDIA_ROOT = os.path.join(BASE_DIR, "mediafiles/")
```
The expression for `BASE_DIR` means: get the path to the current file (`settings.py`), get the parent folder (whatever you named your project), get the parent folder (the root of the project). So `STATIC_ROOT` will then be evaluated to `/staticfiles` (with `/` meaning the root of your project/repo).
With `django-split-settings` `settings` is now a module (instead of a file), so `os.path.dirname(os.path.dirname(os.path.abspath(__file__)))` will evaluate to `/whatever-you-named-your-project` as opposed to `/`.
To fix this `BASE_DIR` needs to be set to the parent folder of `/whatever-you-named-your-project`:
```python
BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
```
## Do you want to contribute?
Read the [CONTRIBUTING.md](https://github.com/sobolevn/django-split-settings/blob/master/CONTRIBUTING.md) file.
## Version history
See [CHANGELOG.md](https://github.com/sobolevn/django-split-settings/blob/master/CHANGELOG.md) file.