Metadata-Version: 2.1
Name: django-underconstruction
Version: 0.1.0
Summary: django-underconstruction shows an under construction page
Home-page: https://github.com/koenwoortman/django-underconstruction
Author: Koen Woortman
Author-email: koensw@outlook.com
License: MIT
Description: # 🛠️ Django Under Construction
        
        > *Put your Django website in under construction mode with a single setting.*
        
        <div align="center">
        	<div>
        		<img src="media/screenshot.png" alt="Example screenshot">
        	</div>
        	<br>
        	<br>
        </div>
        
        ## Install
        
        Install the package from [pypi](https://pypi.org/project/django-underconstruction/).
        
        ```
        $ pip install django-underconstruction
        ```
        
        Add `django_underconstruction` to your INSTALLED_APPS.
        
        ```python
        # settings.py
        
        INSTALLED_APPS = [
            ...
            'django_underconstruction',
            ...
        ]
        ```
        
        Add the `UnderConstructionMiddleware` middleware class to your MIDDLEWARE.
        
        ```python
        # settings.py
        
        MIDDLEWARE = [
            ...
            'django_underconstruction.middleware.UnderConstructionMiddleware',
            ...
        ]
        ```
        
        Once you set `settings.UNDER_CONSTRUCTION` to `True` the under construction page is shown.
        
        ```python
        # settings.py
        
        UNDER_CONSTRUCTION = not DEBUG
        ```
        
        ## Settings
        
        | Option                            | Description                                     | Default        |
        | :-------------------------------- | :---------------------------------------------- | :------------- |
        | **`UNDER_CONSTRUCTION`**          | Whether the site is under construction.         | `False`    |
        | **`UNDER_CONSTRUCTION_TEMPLATE`** | HTML template to show while under construction. | `'django_underconstruction/construction.html'`    |
        
        
        ## License
        
        Released under the [MIT license](https://github.com/koenwoortman/django-underconstruction/blob/main/LICENSE).
        
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
