django-configurations |latest-version|
======================================
|jazzband| |build-status| |codecov| |docs| |python-support| |django-support|
django-configurations eases Django project configuration by relying
on the composability of Python classes. It extends the notion of
Django's module based settings loading with well established
object oriented programming patterns.
Check out the `documentation`_ for more complete examples.
.. |latest-version| image:: https://img.shields.io/pypi/v/django-configurations.svg
:target: https://pypi.python.org/pypi/django-configurations
:alt: Latest version on PyPI
.. |jazzband| image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband
.. |build-status| image:: https://github.com/jazzband/django-configurations/workflows/Test/badge.svg
:target: https://github.com/jazzband/django-configurations/actions
:alt: Build Status
.. |codecov| image:: https://codecov.io/github/jazzband/django-configurations/coverage.svg?branch=master
:target: https://codecov.io/github/jazzband/django-configurations?branch=master
:alt: Test coverage status
.. |docs| image:: https://img.shields.io/readthedocs/django-configurations/latest.svg
:target: https://readthedocs.org/projects/django-configurations/
:alt: Documentation status
.. |python-support| image:: https://img.shields.io/pypi/pyversions/django-configurations.svg
:target: https://pypi.python.org/pypi/django-configurations
:alt: Supported Python versions
.. |django-support| image:: https://img.shields.io/pypi/djversions/django-configurations
:target: https://pypi.org/project/django-configurations
:alt: Supported Django versions
.. _documentation: https://django-configurations.readthedocs.io/en/latest/
Quickstart
----------
Install django-configurations:
.. code-block:: console
$ python -m pip install django-configurations
or, alternatively, if you want to use URL-based values:
.. code-block:: console
$ python -m pip install django-configurations[cache,database,email,search]
Then subclass the included ``configurations.Configuration`` class in your
project's **settings.py** or any other module you're using to store the
settings constants, e.g.:
.. code-block:: python
# mysite/settings.py
from configurations import Configuration
class Dev(Configuration):
DEBUG = True
Set the ``DJANGO_CONFIGURATION`` environment variable to the name of the class
you just created, e.g. in bash:
.. code-block:: console
$ export DJANGO_CONFIGURATION=Dev
and the ``DJANGO_SETTINGS_MODULE`` environment variable to the module
import path as usual, e.g. in bash:
.. code-block:: console
$ export DJANGO_SETTINGS_MODULE=mysite.settings
*Alternatively* supply the ``--configuration`` option when using Django
management commands along the lines of Django's default ``--settings``
command line option, e.g.
.. code-block:: console
$ python -m manage runserver --settings=mysite.settings --configuration=Dev
To enable Django to use your configuration you now have to modify your
**manage.py**, **wsgi.py** or **asgi.py** script to use django-configurations's versions
of the appropriate starter functions, e.g. a typical **manage.py** using
django-configurations would look like this:
.. code-block:: python
#!/usr/bin/env python
import os
import sys
if __name__ == "__main__":
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')
os.environ.setdefault('DJANGO_CONFIGURATION', 'Dev')
from configurations.management import execute_from_command_line
execute_from_command_line(sys.argv)
Notice in line 10 we don't use the common tool
``django.core.management.execute_from_command_line`` but instead
``configurations.management.execute_from_command_line``.
The same applies to your **wsgi.py** file, e.g.:
.. code-block:: python
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')
os.environ.setdefault('DJANGO_CONFIGURATION', 'Dev')
from configurations.wsgi import get_wsgi_application
application = get_wsgi_application()
Here we don't use the default ``django.core.wsgi.get_wsgi_application``
function but instead ``configurations.wsgi.get_wsgi_application``.
Or if you are not serving your app via WSGI but ASGI instead, you need to modify your **asgi.py** file too.:
.. code-block:: python
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')
os.environ.setdefault('DJANGO_CONFIGURATION', 'DEV')
from configurations.asgi import get_asgi_application
application = get_asgi_application()
That's it! You can now use your project with ``manage.py`` and your favorite
WSGI/ASGI enabled server.
Raw data
{
"_id": null,
"home_page": "https://django-configurations.readthedocs.io/",
"name": "django-configurations",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jannis Leidel",
"author_email": "jannis@leidel.info",
"download_url": "https://files.pythonhosted.org/packages/c3/67/5fec7c64118209b20bde6b6f8a82300d9f4a56f7303293e2b31f9940e721/django-configurations-2.5.1.tar.gz",
"platform": null,
"description": "django-configurations |latest-version|\n======================================\n\n|jazzband| |build-status| |codecov| |docs| |python-support| |django-support|\n\ndjango-configurations eases Django project configuration by relying\non the composability of Python classes. It extends the notion of\nDjango's module based settings loading with well established\nobject oriented programming patterns.\n\nCheck out the `documentation`_ for more complete examples.\n\n.. |latest-version| image:: https://img.shields.io/pypi/v/django-configurations.svg\n :target: https://pypi.python.org/pypi/django-configurations\n :alt: Latest version on PyPI\n\n.. |jazzband| image:: https://jazzband.co/static/img/badge.svg\n :target: https://jazzband.co/\n :alt: Jazzband\n\n.. |build-status| image:: https://github.com/jazzband/django-configurations/workflows/Test/badge.svg\n :target: https://github.com/jazzband/django-configurations/actions\n :alt: Build Status\n\n.. |codecov| image:: https://codecov.io/github/jazzband/django-configurations/coverage.svg?branch=master\n :target: https://codecov.io/github/jazzband/django-configurations?branch=master\n :alt: Test coverage status\n\n.. |docs| image:: https://img.shields.io/readthedocs/django-configurations/latest.svg\n :target: https://readthedocs.org/projects/django-configurations/\n :alt: Documentation status\n\n.. |python-support| image:: https://img.shields.io/pypi/pyversions/django-configurations.svg\n :target: https://pypi.python.org/pypi/django-configurations\n :alt: Supported Python versions\n\n.. |django-support| image:: https://img.shields.io/pypi/djversions/django-configurations\n :target: https://pypi.org/project/django-configurations\n :alt: Supported Django versions\n\n.. _documentation: https://django-configurations.readthedocs.io/en/latest/\n\nQuickstart\n----------\n\nInstall django-configurations:\n\n.. code-block:: console\n\n $ python -m pip install django-configurations\n\nor, alternatively, if you want to use URL-based values:\n\n.. code-block:: console\n\n $ python -m pip install django-configurations[cache,database,email,search]\n\nThen subclass the included ``configurations.Configuration`` class in your\nproject's **settings.py** or any other module you're using to store the\nsettings constants, e.g.:\n\n.. code-block:: python\n\n # mysite/settings.py\n\n from configurations import Configuration\n\n class Dev(Configuration):\n DEBUG = True\n\nSet the ``DJANGO_CONFIGURATION`` environment variable to the name of the class\nyou just created, e.g. in bash:\n\n.. code-block:: console\n\n $ export DJANGO_CONFIGURATION=Dev\n\nand the ``DJANGO_SETTINGS_MODULE`` environment variable to the module\nimport path as usual, e.g. in bash:\n\n.. code-block:: console\n\n $ export DJANGO_SETTINGS_MODULE=mysite.settings\n\n*Alternatively* supply the ``--configuration`` option when using Django\nmanagement commands along the lines of Django's default ``--settings``\ncommand line option, e.g.\n\n.. code-block:: console\n\n $ python -m manage runserver --settings=mysite.settings --configuration=Dev\n\nTo enable Django to use your configuration you now have to modify your\n**manage.py**, **wsgi.py** or **asgi.py** script to use django-configurations's versions\nof the appropriate starter functions, e.g. a typical **manage.py** using\ndjango-configurations would look like this:\n\n.. code-block:: python\n\n #!/usr/bin/env python\n\n import os\n import sys\n\n if __name__ == \"__main__\":\n os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')\n os.environ.setdefault('DJANGO_CONFIGURATION', 'Dev')\n\n from configurations.management import execute_from_command_line\n\n execute_from_command_line(sys.argv)\n\nNotice in line 10 we don't use the common tool\n``django.core.management.execute_from_command_line`` but instead\n``configurations.management.execute_from_command_line``.\n\nThe same applies to your **wsgi.py** file, e.g.:\n\n.. code-block:: python\n\n import os\n\n os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')\n os.environ.setdefault('DJANGO_CONFIGURATION', 'Dev')\n\n from configurations.wsgi import get_wsgi_application\n\n application = get_wsgi_application()\n\nHere we don't use the default ``django.core.wsgi.get_wsgi_application``\nfunction but instead ``configurations.wsgi.get_wsgi_application``.\n\nOr if you are not serving your app via WSGI but ASGI instead, you need to modify your **asgi.py** file too.:\n\n.. code-block:: python\n\n import os\n\n os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'mysite.settings')\n os.environ.setdefault('DJANGO_CONFIGURATION', 'DEV')\n\n from configurations.asgi import get_asgi_application\n\n application = get_asgi_application()\n\nThat's it! You can now use your project with ``manage.py`` and your favorite\nWSGI/ASGI enabled server.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "A helper for organizing Django settings.",
"version": "2.5.1",
"project_urls": {
"Homepage": "https://django-configurations.readthedocs.io/",
"Source": "https://github.com/jazzband/django-configurations"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f4e1cc7fd6c0292d56e104f0c8c54ed71c35cafa06838d8f910b918589bf596",
"md5": "1bb3662d1b7a70d3d074de375e41ad38",
"sha256": "ceb84858da2dac846b15e715c2fd936cfc4c7917c074aff8d31700564093955e"
},
"downloads": -1,
"filename": "django_configurations-2.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bb3662d1b7a70d3d074de375e41ad38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 17357,
"upload_time": "2024-03-27T11:42:02",
"upload_time_iso_8601": "2024-03-27T11:42:02.951531Z",
"url": "https://files.pythonhosted.org/packages/6f/4e/1cc7fd6c0292d56e104f0c8c54ed71c35cafa06838d8f910b918589bf596/django_configurations-2.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c3675fec7c64118209b20bde6b6f8a82300d9f4a56f7303293e2b31f9940e721",
"md5": "cbda48183390d4dba48f74dc65b71558",
"sha256": "6e5083757e2bbdf9bb7850567536b96a93515f6b17503d74928ff628db2e0e94"
},
"downloads": -1,
"filename": "django-configurations-2.5.1.tar.gz",
"has_sig": false,
"md5_digest": "cbda48183390d4dba48f74dc65b71558",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 43225,
"upload_time": "2024-03-27T11:40:53",
"upload_time_iso_8601": "2024-03-27T11:40:53.134961Z",
"url": "https://files.pythonhosted.org/packages/c3/67/5fec7c64118209b20bde6b6f8a82300d9f4a56f7303293e2b31f9940e721/django-configurations-2.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 11:40:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jazzband",
"github_project": "django-configurations",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-configurations"
}
JSON
