Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

A simple cache for Django functions and methods

Project 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!

Release history Release notifications

This version
History Node

1.0.0

History Node

0.0.2

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_elephant-1.0.0-py2.py3-none-any.whl (4.8 kB) Copy SHA256 hash SHA256 Wheel 2.7 Dec 9, 2015
django-elephant-1.0.0.tar.gz (5.0 kB) Copy SHA256 hash SHA256 Source None Dec 9, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page