<p align="center">
<img src="https://raw.githubusercontent.com/sobolevn/django-split-settings/master/docs/_static/logo-black.png"
alt="django-split-settings logo">
</p>
---
[](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.
Raw data
{
"_id": null,
"home_page": "https://django-split-settings.readthedocs.io",
"name": "django-split-settings",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "django, settings, configuration, config",
"author": "sobolevn",
"author_email": "mail@sobolevn.me",
"download_url": "https://files.pythonhosted.org/packages/cb/20/400c2094d5db8aed83fb10634d072dc36ae35142425d56d602e11309d589/django_split_settings-1.3.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/sobolevn/django-split-settings/master/docs/_static/logo-black.png\"\n alt=\"django-split-settings logo\">\n</p>\n\n---\n\n[](https://wemake.services)\n[](https://github.com/wemake-services/django-split-settings/actions/workflows/test.yml)\n[](https://codecov.io/gh/sobolevn/django-split-settings)\n[](http://django-split-settings.readthedocs.io/en/latest/?badge=latest)\n[](https://pypi.org/project/django-split-settings/)\n[](https://github.com/wemake-services/wemake-python-styleguide)\n\n\n\nOrganize Django settings into multiple files and directories. Easily\noverride and modify settings. Use wildcards in settings file paths\nand mark settings files as optional.\n\nRead [this blog post](https://sobolevn.me/2017/04/managing-djangos-settings)\nfor more information.\nAlso, check this [example project](https://github.com/wemake-services/wemake-django-template).\n\n\n## Requirements\n\nWhile 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):\n\n- 4.2\n- 5.0\n- 5.1\n\nThis package has no dependencies itself.\n\nIn case you need older `python` / `django` versions support,\nthen consider using older versions of `django-split-settings`.\n\n\n## Installation\n\n```bash\npip install django-split-settings\n```\n\n\n## Usage\n\nReplace your existing `settings.py` with a list of components that\nmake up your Django settings. Preferably create a settings package\nthat contains all the files.\n\nHere's a minimal example:\n\n```python\nfrom split_settings.tools import optional, include\n\ninclude(\n 'components/base.py',\n 'components/database.py',\n optional('local_settings.py')\n)\n```\n\nIn the example, the files `base.py` and `database.py` are included\nin that order from the subdirectory called `components/`.\n`local_settings.py` in the same directory is included if it exists.\n\n**Note:** The local context is passed on to each file, so each\nfollowing file can access and modify the settings declared in the\nprevious files.\n\nWe also made an in-depth [tutorial](https://sobolevn.me/2017/04/managing-djangos-settings).\n\n\n## Tips and tricks\n\nYou can use wildcards in file paths:\n\n```python\ninclude('components/my_app/*.py')\n```\n\nNote that files are included in the order that `glob` returns them,\nprobably in the same order as what `ls -U` would list them. The\nfiles are NOT in alphabetical order.\n\nYou can modify common settings in environment settings simply importing them\n\n```python\n# local_settings.py\nfrom components.base import INSTALLED_APPS\n\nINSTALLED_APPS += (\n 'raven.contrib.django.raven_compat',\n)\n```\n\n\n## Updating `BASE_DIR`\n\nThe `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.\n\n```python\n# Created by django create-project\nBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))\nSTATIC_ROOT = os.path.join(BASE_DIR, \"staticfiles/\")\nMEDIA_ROOT = os.path.join(BASE_DIR, \"mediafiles/\")\n```\n\nThe 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).\n\nWith `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 `/`.\n\nTo fix this `BASE_DIR` needs to be set to the parent folder of `/whatever-you-named-your-project`:\n\n```python\nBASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))\n```\n\n## Do you want to contribute?\n\nRead the [CONTRIBUTING.md](https://github.com/sobolevn/django-split-settings/blob/master/CONTRIBUTING.md) file.\n\n\n## Version history\n\nSee [CHANGELOG.md](https://github.com/sobolevn/django-split-settings/blob/master/CHANGELOG.md) file.\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Organize Django settings into multiple files and directories. Easily override and modify settings. Use wildcards and optional settings files.",
"version": "1.3.1",
"project_urls": {
"Funding": "https://github.com/sponsors/wemake-services",
"Homepage": "https://django-split-settings.readthedocs.io",
"Repository": "https://github.com/sobolevn/django-split-settings"
},
"split_keywords": [
"django",
" settings",
" configuration",
" config"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "378c6bc9468e4715016883997090a303c3b2dc08a9cf2616360e7dd53ebe839b",
"md5": "3dea0ef804dc9bdf835b62aa2312a07c",
"sha256": "c902ef60d5fe8190ff224284f68e3c9015b6f1aca9e9d6bd70bf86394ff32634"
},
"downloads": -1,
"filename": "django_split_settings-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3dea0ef804dc9bdf835b62aa2312a07c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 6407,
"upload_time": "2024-04-05T07:14:12",
"upload_time_iso_8601": "2024-04-05T07:14:12.246439Z",
"url": "https://files.pythonhosted.org/packages/37/8c/6bc9468e4715016883997090a303c3b2dc08a9cf2616360e7dd53ebe839b/django_split_settings-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb20400c2094d5db8aed83fb10634d072dc36ae35142425d56d602e11309d589",
"md5": "ec0644f368c12606faa743630eb73d9d",
"sha256": "c1f57f6b54fc0d93082c12163e76fad082c214f5fa0d16d84a1226d2c9f14f26"
},
"downloads": -1,
"filename": "django_split_settings-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ec0644f368c12606faa743630eb73d9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 5723,
"upload_time": "2024-04-05T07:14:14",
"upload_time_iso_8601": "2024-04-05T07:14:14.101556Z",
"url": "https://files.pythonhosted.org/packages/cb/20/400c2094d5db8aed83fb10634d072dc36ae35142425d56d602e11309d589/django_split_settings-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 07:14:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "wemake-services",
"github_not_found": true,
"lcname": "django-split-settings"
}
JSON
