https://github.com/coderedcorp/wagtail-cache

A simple page cache for Wagtail based on the Django cache middleware.
https://github.com/coderedcorp/wagtail-cache

cache caching django wagtail

Last synced: 2 minutes ago
JSON representation

A simple page cache for Wagtail based on the Django cache middleware.

• Host: GitHub
• URL: https://github.com/coderedcorp/wagtail-cache
• Owner: coderedcorp
• License: other
• Created: 2018-12-08T03:23:12.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T22:05:40.000Z (5 months ago)
• Last Synced: 2025-01-05T18:09:40.074Z (7 days ago)
• Topics: cache, caching, django, wagtail
• Language: Python
• Homepage:
• Size: 136 KB
• Stars: 88
• Watchers: 5
• Forks: 29
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-wagtail - Wagtail Cache - A simple page cache for Wagtail using the Django cache middleware. (Apps / Misc)

README

        
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.