Skip to content

Commit

Permalink
Version bump to 0.5.2, and doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
vsalvino committed Jun 28, 2019
1 parent e1e5e08 commit fc27ce0
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 5 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Wagtail Cache
A simple page cache for Wagtail using the Django cache middleware.
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)

![PyPI - Downloads](https://img.shields.io/pypi/dm/wagtail-cache.svg)
![PyPI](https://img.shields.io/pypi/v/wagtail-cache.svg)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wagtail-cache.svg)
![PyPI - Django Version](https://img.shields.io/pypi/djversions/wagtail-cache.svg)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/wagtail-cache.svg)

```
pip install wagtail-cache
```
Expand All @@ -14,13 +20,13 @@ 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 using Django's cache middleware.
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 in use successfully on live production sites. Eventually the
coderedcms cache will be replaced with wagtail-cache after it has been tested.
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.
6 changes: 6 additions & 0 deletions docs/getting_started/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ in use by ``WAGTAIL_CACHE_BACKEND``::
# Clear the cache manually
clear_cache()

There is also a Django management command to clear the cache:

.. code-block:: console
$ python manage.py clear_wagtail_cache
Clearing the cache automatically
--------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/releases/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Release Notes
.. toctree::
:maxdepth: 1

v0.5.2
v0.5.1
v0.5.0
v0.4.0
Expand Down
5 changes: 5 additions & 0 deletions docs/releases/v0.5.2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
wagtail-cache 0.5.2 release notes
=================================

* Add new management command `clear_wagtail_cache` to clear cache.
* Minor code cleanup.
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,13 @@
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3 :: Only',
'Framework :: Django',
'Framework :: Django :: 2.0',
'Framework :: Django :: 2.1',
'Framework :: Django :: 2.2',
'Framework :: Wagtail',
'Framework :: Wagtail :: 2',
],
Expand Down
2 changes: 1 addition & 1 deletion wagtailcache/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
release = ['0', '5', '1']
release = ['0', '5', '2']
__version__ = "{0}.{1}.{2}".format(release[0], release[1], release[2])
__shortversion__ = "{0}.{1}".format(release[0], release[1])

Expand Down

0 comments on commit fc27ce0

Please sign in to comment.