Metadata-Version: 1.1
Name: django-defaults
Version: 0.0.1
Summary: Django settings sans boilerplate
Home-page: https://github.com/mvasilkov/django-defaults
Author: Mark Vasilkov
Author-email: mvasilkov@gmail.com
License: MIT
Description: django-defaults
        ===
        
        Django settings sans boilerplate
        
        [GitHub][2] ・ [PyPI][3]
        
        Installation
        ---
        
        ```sh
        pip install -U django django-defaults
        ```
        
        Usage
        ---
        
        **Updating an existing Django project**
        
        1️⃣ Create a new file named `defaults.toml` (next to `manage.py`) with the following contents:
        
        ```toml
        [django]
        settings-module = 'PROJECT_NAME.settings'
        routes-module = 'PROJECT_NAME.urls'
        ```
        
        This is the compulsory configuration file.
        
        * `settings-module` is similar to `DJANGO_SETTINGS_MODULE`
        * `routes-module` is similar to `ROOT_URLCONF`
        
        2️⃣ Inject configuration variables into the current module (typically in `settings.py`)
        
        ```python
        from defaults import emplace
        
        emplace()
        ```
        
        This replaces the entirety of the stock `settings.py` file, as generated by the `django-admin startproject` command.
        
        3️⃣ Optional: ensure that the `DJANGO_SETTINGS_MODULE` environment variable is set (in scripts such as `manage.py`)
        
        ```python
        from defaults import setenv
        
        setenv()
        ```
        
        This replaces the `os.environ.setdefault(DJANGO_SETTINGS_MODULE)` line.
        
        **Creating a new Django project**
        
        ```sh
        URL=https://github.com/mvasilkov/django-defaults/archive/template.zip
        django-admin startproject --template $URL --extension py,toml PROJECT_NAME
        ```
        
        See the [project template][1]
        
        [1]: https://github.com/mvasilkov/django-defaults/tree/template
        [2]: https://github.com/mvasilkov/django-defaults
        [3]: https://pypi.org/project/django-defaults/
        
Keywords: django settings toml
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
