Metadata-Version: 2.1
Name: wagtail-cache
Version: 1.0.1
Summary: A simple page cache for Wagtail based on the Django cache middleware.
Home-page: https://github.com/coderedcorp/wagtail-cache
Author: CodeRed LLC
Author-email: info@coderedcorp.com
License: BSD license
Description: Wagtail Cache
        =============
        
        A simple page cache for Wagtail based on the Django cache middleware.
        
        [Documentation](https://docs.coderedcorp.com/wagtail-cache/) |
        [Source code on GitHub](https://github.com/coderedcorp/wagtail-cache)
        
        
        Status
        ------
        
        |                        |                      |
        |------------------------|----------------------|
        | Python Package         |[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wagtail-cache)](https://pypi.org/project/wagtail-cache/) [![PyPI - Django Version](https://img.shields.io/pypi/djversions/wagtail-cache)](https://pypi.org/project/wagtail-cache/) [![PyPI - Wheel](https://img.shields.io/pypi/wheel/wagtail-cache)](https://pypi.org/project/wagtail-cache/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/wagtail-cache)](https://pypi.org/project/wagtail-cache/) [![PyPI](https://img.shields.io/pypi/v/wagtail-cache)](https://pypi.org/project/wagtail-cache/) |
        | Build                  | [![Build Status](https://dev.azure.com/coderedcorp/coderedcms/_apis/build/status/coderedcms?branchName=master)](https://dev.azure.com/coderedcorp/coderedcms/_build/latest?definitionId=9&branchName=master) [![Azure DevOps tests (branch)](https://img.shields.io/azure-devops/tests/coderedcorp/coderedcms/9/master)](https://dev.azure.com/coderedcorp/coderedcms/_build/latest?definitionId=9&branchName=master) [![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/coderedcorp/coderedcms/9/master)](https://dev.azure.com/coderedcorp/coderedcms/_build/latest?definitionId=9&branchName=master) |
        
        
        Quick Start
        -----------
        
        Follow the [Installation Guide](https://docs.coderedcorp.com/wagtail-cache/stable/getting_started/install.html)
        
        
        Why Wagtail Cache?
        ------------------
        
        Django has a robust cache middleware that already has the functionality
        needed to cache web pages effectively. But turning the cache middleware
        on will blindly cache every request and does not work well with a wagtail site.
        
        Wagtail Cache provides a decorator that works well with wagtail pages to
        appropriately cache and serve them similar to Django's cache middleware.
        
        The end result is ultra-fast page serving that requires zero database hits
        to serve cached pages. Other solutions such as template caching still require
        database hits for wagtail to serve a page.
        
        
        Notes
        -----
        This cache feature was originally part of [coderedcms](https://github.com/coderedcorp/coderedcms)
        and has been split out into this separate package. Wagtail Cache is
        tried and tested, and is in use successfully on many live production sites.
        
        
        Contributing
        ------------
        
        To set up your development environment:
        
        1. Create a new environment:
        
        ```
        python -m venv ~/Envs/wagtail-cache
        # Mac and Linux
        source ~/Envs/wagtail-cache/bin/activate
        # Windows (PowerShell)
        ~/Envs/wagtail-cache/Scripts/Activate.ps1
        ```
        
        2. Enter the source code directory and install the package locally with
           additional development tools:
        
        ```
        pip install -r requirements-dev.txt
        ```
        
        3. Write some code.
        
        4. Next, run the static analysis tools (`flake8` and `mypy`)
        
        ```
        flake8 ./wagtailcache/
        mypy ./wagtailcache/
        ```
        
        5. Next, run the units tests. A simple Wagtail project using Wagtail Cache is
           in the `testproject/` directory. The tests will generate a visual HTML file
           at `htmlcov/index.html` when finished, which you can open in your browser.
        ```
        pytest ./testproject/
        ```
        
        6. To build the documentation, run the following, which will output to the
           `docs/_build/html/` directory.
        ```
        sphinx-build -M html ./docs/ ./docs/_build/ -W
        ```
        
        7. To create a python package, run the following, which will output the package
           to the `dist/` directory.
        ```
        python setup.py sdist bdist_wheel
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 2
Description-Content-Type: text/markdown
