Metadata-Version: 1.1
Name: django-splash
Version: 0.2.9
Summary: Splash screen middleware for Django apps
Home-page: https://github.com/edx/django-splash
Author: edX
Author-email: oscm@edx.org
License: Apache Software License 2.0
Description: django-splash
        =============
        
        |pypi-badge| |travis-badge| |codecov-badge| |pyversions-badge|
        |license-badge|
        
        Splash screen middleware for Django apps
        
        Overview
        --------
        
        Checks incoming requests, to redirect users to a configured splash screen URL
        if they don't have the proper cookie set. This can be used to display a small
        marketing landing page, protect an alpha website from the public eye, make an
        announcement, etc.
        
        Meant to be used with https://github.com/edx/edx-platform/ -- or you will need
        to import the config_models application to your Django application:
        https://github.com/edx/django-config-models
        
        Installation
        ------------
        
        Add the application to the `INSTALLED_APPS`:
        
        ::
        
            python
            INSTALLED_APPS = (
                ...
                # Splash screen
                'splash',
            )
        
        Add the middleware to the configuration:
        
        ::
        
            python
            MIDDLEWARE_CLASSES = (
                ...
                'splash.middleware.SplashMiddleware',
            )
        
        Run the migrations:
        
        ``$ ./manage.py migrate splash``
        
        Then go to your Django admin, in http://yourserver/admin/splash/splashconfig/add/
        and configure the following variables:
        
        * `enabled`: To activate the feature
        * `cookie_name`: The name of the cookie
        * `cookie_allowed_values`: The user cookie value must match one of the values to not be redirected to the splash screen URL
        * `unaffected_users`: Users which should never be redirected (usernames)
        * `redirect_url`: The URL the users should be redirected to when they don't have the right cookie
        
        License
        -------
        
        The code in this repository is licensed under the Apache Software License 2.0 unless
        otherwise noted.
        
        Please see ``LICENSE.txt`` for details.
        
        How To Contribute
        -----------------
        
        Contributions are very welcome.
        
        Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
        
        Even though they were written with ``edx-platform`` in mind, the guidelines
        should be followed for Open edX code in general.
        
        Reporting Security Issues
        -------------------------
        
        Please do not report security issues in public. Please email security@edx.org.
        
        Getting Help
        ------------
        
        Have a question about this repository, or about Open edX in general?  Please
        refer to this `list of resources`_ if you need any assistance.
        
        .. _list of resources: https://open.edx.org/getting-help
        
        
        .. |pypi-badge| image:: https://img.shields.io/pypi/v/django-splash.svg
            :target: https://pypi.python.org/pypi/django-splash/
            :alt: PyPI
        
        .. |travis-badge| image:: https://travis-ci.org/edx/django-splash.svg?branch=master
            :target: https://travis-ci.org/edx/django-splash
            :alt: Travis
        
        .. |codecov-badge| image:: http://codecov.io/github/edx/django-splash/coverage.svg?branch=master
            :target: http://codecov.io/github/edx/django-splash?branch=master
            :alt: Codecov
        
        .. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/django-splash.svg
            :target: https://pypi.python.org/pypi/django-splash/
            :alt: Supported Python versions
        
        .. |license-badge| image:: https://img.shields.io/github/license/edx/django-splash.svg
            :target: https://github.com/edx/django-splash/blob/master/LICENSE.txt
            :alt: License
        
        
        Change Log
        ----------
        
        ..
           All enhancements and patches to django-splash will be documented
           in this file.  It adheres to the structure of http://keepachangelog.com/ ,
           but in reStructuredText instead of Markdown (for ease of incorporation into
           Sphinx documentation and the PyPI description).
        
           This project adheres to Semantic Versioning (http://semver.org/).
        
        .. There should always be an "Unreleased" section for changes pending release.
        
        Unreleased
        ~~~~~~~~~~
        
        *
        
        [0.2.2] - 2018-02-09
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Added
        _____
        
        * Automatic upload to PyPI on tags.
        
        
        [0.2.1] - 2018-02-07
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Added
        _____
        
        * First release on PyPI.
        
Keywords: Django edx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.8
