Hopiu/django-cachalot
1
0
Fork 0
mirror of https://github.com/Hopiu/django-cachalot.git synced 2026-03-16 21:30:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No effort, no worry, maximum performance.
5 commits 4 branches 45 tags 1.7 MiB
Python 99.7%
HTML 0.3%
Find a file
Bertrand Bordage 65f064bae7 Adds a test suite.
2014-09-28 01:42:41 +02:00
cachalot Adds a test suite. 2014-09-28 01:42:41 +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
django-cachalot.jpg 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 Typo. 2014-09-26 20:27:35 +02:00
requirements.txt Version 0.1.0. 2014-09-26 16:53:44 +02:00
runtests.py Adds a test suite. 2014-09-28 01:42:41 +02:00
setup.py chmod +x setup.py. 2014-09-26 20:27:25 +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 databases
- Write tests, including multi-table inheritance, prefetch_related, etc
- Find out if it’s 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