https://github.com/codeinthehole/django-cacheback

Smart caching for Django using Celery to refresh cached items asynchronously.
https://github.com/codeinthehole/django-cacheback

Last synced: 30 days ago
JSON representation

Smart caching for Django using Celery to refresh cached items asynchronously.

• Host: GitHub
• URL: https://github.com/codeinthehole/django-cacheback
• Owner: codeinthehole
• License: mit
• Created: 2012-07-28T21:39:30.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-07-19T09:15:27.000Z (5 months ago)
• Last Synced: 2024-11-07T23:49:57.303Z (about 1 month ago)
• Language: Python
• Homepage: http://codeinthehole.com/writing/cacheback-asynchronous-cache-refreshing-for-django/
• Size: 605 KB
• Stars: 375
• Watchers: 12
• Forks: 77
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-django-performance - django-cacheback - Smart caching for Django using Celery to refresh cached items asynchronously. (Caching / Tools)
• stars - codeinthehole/django-cacheback - Smart caching for Django using Celery to refresh cached items asynchronously. (Python)
• stars - codeinthehole/django-cacheback - Smart caching for Django using Celery to refresh cached items asynchronously. (Python)

README

        
=========

Cacheback

=========

----------------------------------------

Asynchronous cache refreshing for Django

----------------------------------------

What does this library do?

--------------------------

It's an extensible caching library that refreshes stale cache items

asynchronously using a Celery_ or rq_ task (utilizing django-rq). The key

idea being that it's better to serve a stale item (and populate the cache

asynchronously) than block the response process in order to populate the cache

synchronously.

.. _Celery: http://celeryproject.org/

.. _rq: http://python-rq.org/

Using this library, you can rework your views so that all reads are from

cache - which can be a significant performance boost.

A corollary of this technique is that cache hammering can be handled simply and

elegantly, avoiding sudden surges of expensive reads when a cached item becomes stale.

Do you have good docs?

----------------------

Yup - `over on readthedocs.org`_.

.. _`over on readthedocs.org`: http://django-cacheback.readthedocs.org/en/latest/

Supported versions

------------------

Python 3.6+ is supported. Django 2.2+ is supported.

Do you have tests?

------------------

You betcha!

.. image:: https://github.com/codeinthehole/django-cacheback/workflows/CI/badge.svg?branch=master

     :target: https://github.com/codeinthehole/django-cacheback/actions?workflow=CI

     :alt: CI Status

Can I use this in my project?

-----------------------------

Probably - subject to the `MIT license`_.

.. _`MIT license`: https://github.com/codeinthehole/django-cacheback/blob/master/LICENSE

I want to contribute!

---------------------

Brilliant!  Here are the `contributing guidelines`_.

.. _`contributing guidelines`: http://django-cacheback.readthedocs.org/en/latest/contributing.html