Skip to main content

Your project description goes here

Project description

https://badge.fury.io/py/django-maintenance-window.svg https://travis-ci.org/JostCrow/django-maintenance-window.svg?branch=master https://codecov.io/gh/JostCrow/django-maintenance-window/branch/master/graph/badge.svg Lintly https://bettercodehub.com/edge/badge/JostCrow/django-maintenance-window?branch=master Maintainability

Your project description goes here

Documentation

The full documentation is at https://django-maintenance-window.readthedocs.io.

Quickstart

Install django-maintenance-window:

pip install django-maintenance-window

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django-solo',
    'django_maintenance_window',
    ...
)

Add django-maintenance-window’s middleware to the middleware:

MIDDLEWARE_CLASSES = [
    ...
    'django_maintenance_window.middleware.MaintenanceModeMiddleware',
    ...
]

or

MIDDLEWARE = [
    ...
    'django_maintenance_window.middleware.MaintenanceModeMiddleware',
    ...
]

Settings

  • MAINTENANCE_TEMPLATE = ‘django_maintenance_window/maintenance.html’
    Overwrite the template that is used for the maintenance template
  • MAINTENANCE_DISPLAY_END_DATE = False
    If the end date should be displayed at the bottom of the page.
  • MAINTENANCE_EXCLUDE_ADMIN_URLS = True
    This will allow accessing the admin even if maintenance mode is active.
  • MAINTENANCE_EXCLUDE_SUPER_USER = False
    This will allow super users to see the site even if maintenance mode is active.
  • MAINTENANCE_EXCLUDE_STAFF_USER = False
    This will allow staff users to see the site even if maintenance mode is active.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.2.1 (2017-10-30)

  • Fixed that the admin would give a 500 when you only set the maintenance_from.

0.2.0 (2017-10-26)

  • Now the admin exclude will work with i18n urls.
  • MAINTENANCE_EXCLUDE_ADMIN_URLS is now a setting (default=True)
  • MAINTENANCE_EXCLUDE_SUPER_USER is now a setting (default=False)
  • MAINTENANCE_EXCLUDE_STAFF_USER is now a setting (default=False)

0.1.0 (2017-10-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-maintenance-window, version 0.3.3
Filename, size File type Python version Upload date Hashes
Filename, size django-maintenance-window-0.3.3.tar.gz (11.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page