Metadata-Version: 1.1
Name: django-brotli
Version: 0.1.2
Summary: Middleware that compresses response using brotli algorithm.
Home-page: https://github.com/illagrenan/django-brotli
Author: Vasek Dohnal
Author-email: vaclav.dohnal@gmail.com
License: MIT
Description: ===========================================================================
        Django Brotli: *Middleware that compresses response using brotli algorithm*
        ===========================================================================
        
        .. image:: https://img.shields.io/pypi/v/django-brotli.svg
            :target: https://pypi.python.org/pypi/django-brotli
            :alt: PyPi
        
        .. image:: https://img.shields.io/badge/license-MIT-blue.svg
            :target: https://pypi.python.org/pypi/django-brotli/
            :alt: MIT
        
        .. image:: https://img.shields.io/travis/illagrenan/django-brotli.svg
            :target: https://travis-ci.org/illagrenan/django-brotli
            :alt: TravisCI
        
        .. image:: https://img.shields.io/coveralls/illagrenan/django-brotli.svg
            :target: https://coveralls.io/github/illagrenan/django-brotli?branch=master
            :alt: Coverage
        
        .. image:: https://pyup.io/repos/github/illagrenan/django-brotli/shield.svg
            :target: https://pyup.io/repos/github/illagrenan/django-brotli/
            :alt: Updates
        
        .. image:: https://img.shields.io/pypi/implementation/django-brotli.svg
            :target: https://pypi.python.org/pypi/django_brotli/
            :alt: Supported Python implementations
        
        .. image:: https://img.shields.io/pypi/pyversions/django-brotli.svg
            :target: https://pypi.python.org/pypi/django_brotli/
            :alt: Supported Python versions
        
        Introduction
        ------------
        
        This project consists of ``BrotliMiddleware`` which works the same as Django ``GZipMiddleware`` (`Docs`_/`Source`_). ``BrotliMiddleware`` will compress content of HTTP response using brotli algorithm (Brotli Compressed Data Format is defined in `RFC 7932`_).
        
        In November 2016 is brotli supported by Firefox, Chrome, Android Browser and Opera (detailed stats on `caniuse`_). Brotli is applied only when client has sent ``Accept-Encoding`` header containing ``br``.
        
        .. _`Docs`: https://docs.djangoproject.com/en/dev/ref/middleware/#module-django.middleware.gzip
        .. _`Source`: https://github.com/django/django/blob/master/django/middleware/gzip.py#L10-L52
        .. _`RFC 7932`: https://www.ietf.org/rfc/rfc7932.txt
        .. _`caniuse`: http://caniuse.com/#search=brotli
        
        Installation
        ------------
        
        **This software is in alpha version and should not be used in production.**
        
        - Supported Python versions are: ``3.4.``, ``3.5``, ``3.6-dev`` and ``3.7-dev``.
        - Supported Django versions are: ``1.8.x``, ``1.9.x`` and ``1.10.x``.
        
        .. code:: shell
        
            pip install --upgrade django-brotli
        
        
        Add ``django_brotli.middleware.BrotliMiddleware`` to ``MIDDLEWARE``:
        
        .. code:: python
        
            MIDDLEWARE = [
                'django_brotli.middleware.BrotliMiddleware',
                # ...
            ]
        
        
        Credits and Resources
        ---------------------
        
        - |brotlipy|_.
        - `Brotli on Wikipedia <https://en.wikipedia.org/wiki/Brotli>`_
        
        .. |brotlipy| replace:: ``brotlipy`` Python bindings to the Brotli compression library
        .. _brotlipy: https://github.com/python-hyper/brotlipy
        
        
        License
        -------
        
        The MIT License (MIT)
        
        Copyright (c) 2016 Vašek Dohnal (@illagrenan)
        
        Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be included
        in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
        CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
