{ "info": { "author": "edX", "author_email": "oscm@edx.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Django", "Framework :: Django :: 1.11", "Framework :: Django :: 1.8", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6" ], "description": "django-splash\n=============\n\n|pypi-badge| |travis-badge| |codecov-badge| |pyversions-badge|\n|license-badge|\n\nSplash screen middleware for Django apps\n\nOverview\n--------\n\nChecks incoming requests, to redirect users to a configured splash screen URL\nif they don't have the proper cookie set. This can be used to display a small\nmarketing landing page, protect an alpha website from the public eye, make an\nannouncement, etc.\n\nMeant to be used with https://github.com/edx/edx-platform/ -- or you will need\nto import the config_models application to your Django application:\nhttps://github.com/edx/django-config-models\n\nInstallation\n------------\n\nAdd the application to the `INSTALLED_APPS`:\n\n::\n\n python\n INSTALLED_APPS = (\n ...\n # Splash screen\n 'splash',\n )\n\nAdd the middleware to the configuration:\n\n::\n\n python\n MIDDLEWARE_CLASSES = (\n ...\n 'splash.middleware.SplashMiddleware',\n )\n\nRun the migrations:\n\n``$ ./manage.py migrate splash``\n\nThen go to your Django admin, in http://yourserver/admin/splash/splashconfig/add/\nand configure the following variables:\n\n* `enabled`: To activate the feature\n* `cookie_name`: The name of the cookie\n* `cookie_allowed_values`: The user cookie value must match one of the values to not be redirected to the splash screen URL\n* `unaffected_users`: Users which should never be redirected (usernames)\n* `redirect_url`: The URL the users should be redirected to when they don't have the right cookie\n\nLicense\n-------\n\nThe code in this repository is licensed under the Apache Software License 2.0 unless\notherwise noted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\n\nPlease read `How To Contribute `_ for details.\n\nEven though they were written with ``edx-platform`` in mind, the guidelines\nshould be followed for Open edX code in general.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about Open edX in general? Please\nrefer to this `list of resources`_ if you need any assistance.\n\n.. _list of resources: https://open.edx.org/getting-help\n\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/django-splash.svg\n :target: https://pypi.python.org/pypi/django-splash/\n :alt: PyPI\n\n.. |travis-badge| image:: https://travis-ci.org/edx/django-splash.svg?branch=master\n :target: https://travis-ci.org/edx/django-splash\n :alt: Travis\n\n.. |codecov-badge| image:: http://codecov.io/github/edx/django-splash/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/django-splash?branch=master\n :alt: Codecov\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/django-splash.svg\n :target: https://pypi.python.org/pypi/django-splash/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/django-splash.svg\n :target: https://github.com/edx/django-splash/blob/master/LICENSE.txt\n :alt: License\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to django-splash will be documented\n in this file. It adheres to the structure of http://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (http://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n*\n\n[0.2.2] - 2018-02-09\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* Automatic upload to PyPI on tags.\n\n\n[0.2.1] - 2018-02-07\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* First release on PyPI.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/edx/django-splash", "keywords": "Django edx", "license": "Apache Software License 2.0", "maintainer": "", "maintainer_email": "", "name": "django-splash", "package_url": "https://pypi.org/project/django-splash/", "platform": "", "project_url": "https://pypi.org/project/django-splash/", "project_urls": { "Homepage": "https://github.com/edx/django-splash" }, "release_url": "https://pypi.org/project/django-splash/0.2.2/", "requires_dist": [ "Django (<2.0,>=1.8)" ], "requires_python": "", "summary": "Splash screen middleware for Django apps", "version": "0.2.2" }, "last_serial": 3575385, "releases": { "0.2.1": [ { "comment_text": "", "digests": { "md5": "9f6aa680b0f5877042ce6b72b88edda8", "sha256": "dcc2167bd092d7e138097136896ac56056e3046e08ebfadcc3fff6362574990a" }, "downloads": -1, "filename": "django_splash-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9f6aa680b0f5877042ce6b72b88edda8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8811, "upload_time": "2018-02-08T19:53:05", "url": "https://files.pythonhosted.org/packages/27/aa/af49d349166c6f25dce72b5836b1c47ddecf7fada0a639a8bdfda4a2534f/django_splash-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9b3dfbce161ba5e4bbfcdf22a89ba113", "sha256": "d642af63043665aa568c2a85334ce10e2cdcab8e097223bec5b84454cec2abaa" }, "downloads": -1, "filename": "django-splash-0.2.1.tar.gz", "has_sig": false, "md5_digest": "9b3dfbce161ba5e4bbfcdf22a89ba113", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9337, "upload_time": "2018-02-08T19:53:08", "url": "https://files.pythonhosted.org/packages/17/2a/fc61a17e2716fa1283817a477fad4cdb11c4eb14b136f262e92bcf40621f/django-splash-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "c737d4a5ce5be3edc9e3a714b82931af", "sha256": "76e3c39113c6d7dc06617fa0fd0c682462e509684b7b0afa41d60e92db88b360" }, "downloads": -1, "filename": "django_splash-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c737d4a5ce5be3edc9e3a714b82931af", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8867, "upload_time": "2018-02-12T16:13:03", "url": "https://files.pythonhosted.org/packages/a4/a4/e1ed188630051efb015d1fb68e43b9a19cf450545fff72d50cf76433f164/django_splash-0.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27dfaa4675e47ae07ff9f88782ae9f5c", "sha256": "d874a7ec7ec85a377cabcae1ae85785f2daa81178d58a5bbb5121b8b0c382502" }, "downloads": -1, "filename": "django-splash-0.2.2.tar.gz", "has_sig": false, "md5_digest": "27dfaa4675e47ae07ff9f88782ae9f5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10673, "upload_time": "2018-02-12T16:13:05", "url": "https://files.pythonhosted.org/packages/47/d5/54725dcfafc2bf7936dbc23188372767e54166026d15b8499d838228c0cb/django-splash-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c737d4a5ce5be3edc9e3a714b82931af", "sha256": "76e3c39113c6d7dc06617fa0fd0c682462e509684b7b0afa41d60e92db88b360" }, "downloads": -1, "filename": "django_splash-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c737d4a5ce5be3edc9e3a714b82931af", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8867, "upload_time": "2018-02-12T16:13:03", "url": "https://files.pythonhosted.org/packages/a4/a4/e1ed188630051efb015d1fb68e43b9a19cf450545fff72d50cf76433f164/django_splash-0.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27dfaa4675e47ae07ff9f88782ae9f5c", "sha256": "d874a7ec7ec85a377cabcae1ae85785f2daa81178d58a5bbb5121b8b0c382502" }, "downloads": -1, "filename": "django-splash-0.2.2.tar.gz", "has_sig": false, "md5_digest": "27dfaa4675e47ae07ff9f88782ae9f5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10673, "upload_time": "2018-02-12T16:13:05", "url": "https://files.pythonhosted.org/packages/47/d5/54725dcfafc2bf7936dbc23188372767e54166026d15b8499d838228c0cb/django-splash-0.2.2.tar.gz" } ] }