Metadata-Version: 1.1
Name: django-cache-magic
Version: 0.1.0
Summary: Django Cache Magic
Home-page: https://github.com/ntucker/django-cache-magic
Author: Nathaniel Tucker
Author-email: me@ntucker.me
License: BSD
Description: Django-Cache-Magic
        ================
        
        Cache magic addresses two common scenarios for caching and cache invalidation
        for django models: *instance caching* and *related objects caching*.
        
        Instance caching: Storing instances of objects in your cache layer
        as well as your database.
        
        Related objects caching: Storing a collection of objects related to another
        object referenced by relational constraints (ForeignKey, ManyToMany, etc.)
        
        Installing
        ----------
            pip install -e "git+https://github.com/ntucker/django-cache-magic#egg=cachemagic"
        
        Usage
        -----
        To start autocaching model instances, add a CacheController to your model:
        
            from django.db import models
            from cachemagic import CacheController
        
            class myModel(models.Model):
                f1 = models.IntegerField()
                f2 = models.TextField()
        
                cache = CacheController()
        
            myModel.cache.get(pk=27)
        
        When using cachemagic, you should avoid django operations that update multiple
        rows at once, since these operations typically don't emit the signals that
        cachemagic relies on for cache invalidation. This includes methods like
        [`Queryset.update`](https://docs.djangoproject.com/en/1.3/ref/models/querysets/#update),
        [`Queryset.delete`](https://docs.djangoproject.com/en/1.3/ref/models/querysets/#delete),
        and
        [`RelatedManager.clear`](https://docs.djangoproject.com/en/1.3/ref/models/relations/#django.db.models.fields.related.RelatedManager.clear)
        
        Find the complete documentation at [django-cache-magic.readthedocs.org](http://django-cache-magic.readthedocs.org/).
        
        
        Thanks
        ------
        Big thanks to [Travis Fischer](https://github.com/travisfischer) for drafting
        a lot of documentation and tests!
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
