Go to file
Bertrand Bordage 53f8078a55 Version 0.1.0. 2014-09-26 16:53:44 +02:00
cachalot Version 0.1.0. 2014-09-26 16:53:44 +02:00
.gitignore Version 0.1.0. 2014-09-26 16:53:44 +02:00
AUTHORS.rst Version 0.1.0. 2014-09-26 16:53:44 +02:00
LICENSE Version 0.1.0. 2014-09-26 16:53:44 +02:00
README.rst Version 0.1.0. 2014-09-26 16:53:44 +02:00
django-cachalot.jpg Version 0.1.0. 2014-09-26 16:53:44 +02:00
requirements.txt Version 0.1.0. 2014-09-26 16:53:44 +02:00
setup.py Version 0.1.0. 2014-09-26 16:53:44 +02:00

README.rst

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Django-cachalot
===============

Caches your Django ORM queries and automatically invalidates them.

**In alpha, do not use for production**

.. image:: https://raw.github.com/BertrandBordage/django-cachalot/master/django-cachalot.jpg


Quick start
-----------

Requirements
............

Django-cachalot currently requires Django 1.6
and `django-redis <https://github.com/niwibe/django-redis>`_ as your default
cache backend.  It should work with both Python 2 & 3.

Usage
.....

#. `pip install -e git+https://github.com/BertrandBordage/django-cachalot#egg=django-cachalot`
#. Add ``'cachalot',`` to your ``INSTALLED_APPS``
#. Enjoy!


What still needs to be done
---------------------------

- Correctly invalidate ``.extra`` queries
- Handle transactions
- Handle multiple database
- Write tests, including multi-table inheritance, prefetch_related, etc
- Find out if its thread-safe and test it
- Add a ``CACHALOT_ENABLED`` setting
- Add a setting to choose a cache other than ``'default'``
- Add support for other caches like memcached