wagtail-cache


Namewagtail-cache JSON
Version 2.5.1 PyPI version JSON
download
home_pageNone
SummaryA simple page cache for Wagtail based on the Django cache middleware.
upload_time2024-08-21 21:37:34
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseBSD License Copyright (c) 2018, CodeRed LLC All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ******************************************************************************* Icon file "wagtailcache-bolt.svg": * Was sourced from the Fork Awesome project at https://github.com/ForkAwesome/Fork-Awesome. * Is licensed under the Creative Commons Attribution 3.0 Unported license, a copy of which is available at https://creativecommons.org/licenses/by/3.0/ * Has been modified from the original sources.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Wagtail Cache
=============

A fast and simple page cache for Wagtail, inspired by the Django cache
middleware.

[Documentation](https://docs.coderedcorp.com/wagtail-cache/) |
[Source code on GitHub](https://github.com/coderedcorp/wagtail-cache) |
[PyPI](https://pypi.org/project/wagtail-cache/)


Status
------

|                        |                      |
|------------------------|----------------------|
| Python Package         | [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/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/cr-github/_apis/build/status/wagtail-cache?branchName=main)](https://dev.azure.com/coderedcorp/cr-github/_build/latest?definitionId=9&branchName=main) [![Azure DevOps tests (branch)](https://img.shields.io/azure-devops/tests/coderedcorp/cr-github/9/main)](https://dev.azure.com/coderedcorp/cr-github/_build/latest?definitionId=9&branchName=main) [![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/coderedcorp/cr-github/9/main)](https://dev.azure.com/coderedcorp/cr-github/_build/latest?definitionId=9&branchName=main) |


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 middleware, decorator, and mixin that works well with
Wagtail pages, Django views, or even manually on any request/response to
efficiently cache and serve from cache.

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.

Wagtail Cache also does not require any additional infrastructure such as Redis,
Memcached, proxies, etc. It can work directly off the filesystem, or using any
of Django's built-in cache backends.


Contributing
------------

Follow the [contributing guide](https://docs.coderedcorp.com/wagtail-cache/stable/contributing.html)


Attribution
-----------

Icon file "wagtailcache-bolt.svg":

* Was sourced from the Fork Awesome project at
   https://github.com/ForkAwesome/Fork-Awesome.

* Is licensed under the Creative Commons Attribution 3.0 Unported license,
   a copy of which is available at https://creativecommons.org/licenses/by/3.0/

* Has been modified from the original sources.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wagtail-cache",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "CodeRed LLC <info@coderedcorp.com>",
    "download_url": "https://files.pythonhosted.org/packages/c4/38/a8bcf6631d360de151bfcf79f980406b8a02d1ef323580e218437bb4d05f/wagtail_cache-2.5.1.tar.gz",
    "platform": null,
    "description": "Wagtail Cache\r\n=============\r\n\r\nA fast and simple page cache for Wagtail, inspired by the Django cache\r\nmiddleware.\r\n\r\n[Documentation](https://docs.coderedcorp.com/wagtail-cache/) |\r\n[Source code on GitHub](https://github.com/coderedcorp/wagtail-cache) |\r\n[PyPI](https://pypi.org/project/wagtail-cache/)\r\n\r\n\r\nStatus\r\n------\r\n\r\n|                        |                      |\r\n|------------------------|----------------------|\r\n| Python Package         | [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/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/) |\r\n| Build                  | [![Build Status](https://dev.azure.com/coderedcorp/cr-github/_apis/build/status/wagtail-cache?branchName=main)](https://dev.azure.com/coderedcorp/cr-github/_build/latest?definitionId=9&branchName=main) [![Azure DevOps tests (branch)](https://img.shields.io/azure-devops/tests/coderedcorp/cr-github/9/main)](https://dev.azure.com/coderedcorp/cr-github/_build/latest?definitionId=9&branchName=main) [![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/coderedcorp/cr-github/9/main)](https://dev.azure.com/coderedcorp/cr-github/_build/latest?definitionId=9&branchName=main) |\r\n\r\n\r\nQuick Start\r\n-----------\r\n\r\nFollow the [Installation Guide](https://docs.coderedcorp.com/wagtail-cache/stable/getting_started/install.html)\r\n\r\n\r\nWhy Wagtail Cache?\r\n------------------\r\n\r\nDjango has a robust cache middleware that already has the functionality\r\nneeded to cache web pages effectively. But turning the cache middleware\r\non will blindly cache every request and does not work well with a Wagtail site.\r\n\r\nWagtail Cache provides a middleware, decorator, and mixin that works well with\r\nWagtail pages, Django views, or even manually on any request/response to\r\nefficiently cache and serve from cache.\r\n\r\nThe end result is ultra-fast page serving that requires zero database hits\r\nto serve cached pages. Other solutions such as template caching still require\r\ndatabase hits for Wagtail to serve a page.\r\n\r\nWagtail Cache also does not require any additional infrastructure such as Redis,\r\nMemcached, proxies, etc. It can work directly off the filesystem, or using any\r\nof Django's built-in cache backends.\r\n\r\n\r\nContributing\r\n------------\r\n\r\nFollow the [contributing guide](https://docs.coderedcorp.com/wagtail-cache/stable/contributing.html)\r\n\r\n\r\nAttribution\r\n-----------\r\n\r\nIcon file \"wagtailcache-bolt.svg\":\r\n\r\n* Was sourced from the Fork Awesome project at\r\n   https://github.com/ForkAwesome/Fork-Awesome.\r\n\r\n* Is licensed under the Creative Commons Attribution 3.0 Unported license,\r\n   a copy of which is available at https://creativecommons.org/licenses/by/3.0/\r\n\r\n* Has been modified from the original sources.\r\n",
    "bugtrack_url": null,
    "license": "BSD License  Copyright (c) 2018, CodeRed LLC All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   *******************************************************************************   Icon file \"wagtailcache-bolt.svg\":  * Was sourced from the Fork Awesome project at https://github.com/ForkAwesome/Fork-Awesome.  * Is licensed under the Creative Commons Attribution 3.0 Unported license, a copy of which is available at https://creativecommons.org/licenses/by/3.0/  * Has been modified from the original sources. ",
    "summary": "A simple page cache for Wagtail based on the Django cache middleware.",
    "version": "2.5.1",
    "project_urls": {
        "Source": "https://github.com/coderedcorp/wagtail-cache"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a45cfdc1cba5c998dd5379fa70e0d6224e231f1985fd85dc74cab8165cfddbeb",
                "md5": "0d38835f8f85b8e26c67f166b9182dbb",
                "sha256": "1e8133f88d60bf7c6f97f6858e79d846394c70a22d82722e10c79c3d32d456ad"
            },
            "downloads": -1,
            "filename": "wagtail_cache-2.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d38835f8f85b8e26c67f166b9182dbb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 14771,
            "upload_time": "2024-08-21T21:37:33",
            "upload_time_iso_8601": "2024-08-21T21:37:33.827387Z",
            "url": "https://files.pythonhosted.org/packages/a4/5c/fdc1cba5c998dd5379fa70e0d6224e231f1985fd85dc74cab8165cfddbeb/wagtail_cache-2.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c438a8bcf6631d360de151bfcf79f980406b8a02d1ef323580e218437bb4d05f",
                "md5": "ba6720d21fca7be050de8d05d54ae7f3",
                "sha256": "6344342dd0c383ec2eac80195d48aa61a4a1966992a12be23013342f9341c20d"
            },
            "downloads": -1,
            "filename": "wagtail_cache-2.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ba6720d21fca7be050de8d05d54ae7f3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12151,
            "upload_time": "2024-08-21T21:37:34",
            "upload_time_iso_8601": "2024-08-21T21:37:34.964949Z",
            "url": "https://files.pythonhosted.org/packages/c4/38/a8bcf6631d360de151bfcf79f980406b8a02d1ef323580e218437bb4d05f/wagtail_cache-2.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-21 21:37:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "coderedcorp",
    "github_project": "wagtail-cache",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "wagtail-cache"
}
        
Elapsed time: 0.63429s