Metadata-Version: 1.1
Name: django-elephant
Version: 1.0.0
Summary: A simple cache for Django functions and methods
Home-page: https://github.com/jairhenrique/django-elephant
Author: Jair Henrique
Author-email: jair.henrique@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: # django-elephant
        
        [![Build Status](https://travis-ci.org/jairhenrique/django-elephant.svg)](https://travis-ci.org/jairhenrique/django-elephant)
        [![PyPI version](https://badge.fury.io/py/django-elephant.svg)](https://badge.fury.io/py/django-elephant)
        [![codecov.io](https://codecov.io/github/jairhenrique/django-elephant/coverage.svg?branch=master)](https://codecov.io/github/jairhenrique/django-elephant?branch=master)
        [![Code Issues](https://www.quantifiedcode.com/api/v1/project/03084631935244baa8335617d6502d11/badge.svg)](https://www.quantifiedcode.com/app/project/03084631935244baa8335617d6502d11)
        
        
        *django-elephant is a simple wrapper to cache responses of Django methods or functions*
        
        
        ## Setup
        
        ```bash
        pip install django-elephant
        ```
        
        ## Usage
        
        #### Basic:
        
        ```python
        from elephant import memorize
        
        @memorize()
        def foo(bar):
            return bar
        ```
        
        
        #### Set cache configuration:
        
        ```python
        from django.core.cache import caches
        from elephant import memorize
        
        other_cache = caches['other_cache']
        
        @memorize(
            cache=other_cache
        )
        def foo(bar):
            return bar
        ```
        
        
        #### Set cache timeout:
        
        ```python
        from elephant import memorize
        
        @memorize(
            timeout=1987
        )
        def foo(bar):
            return bar
        ```
        
        #### Set cache key:
        
        ```python
        from elephant import memorize
        
        def my_custom_key(function, *args, **kwargs):
            return '{}.{}'.format(
                'elephant_'
                function.__name__
            )
        
        @memorize(
            cache_key=my_custom_key
        )
        def foo(bar):
            return bar
        ```
        
        ## Requirements
        - Django>=1.5
        
        
        ## Contribute
        - Fork and make a pull request!
        
Keywords: django cache
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
