================ django-cache-url

.. image:: https://img.shields.io/pypi/v/django-cache-url.svg :alt: PyPI version :target: https://pypi.org/project/django-cache-url/

.. image:: https://img.shields.io/pypi/pyversions/django-cache-url.svg :alt: Supported Python versions :target: https://pypi.org/project/django-cache-url/

.. image:: https://github.com/epicserve/django-cache-url/workflows/CI/badge.svg?branch=master :target: https://github.com/epicserve/django-cache-url/actions :alt: Tests

This simple Django utility allows you to utilize the 12factor <http://www.12factor.net/backing-services>_ inspired CACHE_URL environment variable to configure your Django application.

This was built with inspiration from rdegges' django-heroku-memcacheify <https://github.com/rdegges/django-heroku-memcacheify>_ as a way to use CACHE_URL in apps that aren't necessarily hosted on Heroku.

The internals borrow heavily from kennethreitz's dj-database-url <https://github.com/kennethreitz/dj-database-url>_.

Usage

Configure your cache in settings.py from CACHE_URL::

import django_cache_url
CACHES = {'default': django_cache_url.config()}

Defaults to local memory cache if CACHE_URL isn't set.

Parse an arbitrary Cache URL::

CACHES = {'default': django_cache_url.parse('memcache://...')}

Supported Caches

Support currently exists for:

• locmem (default): 'locmem://[NAME]'
• db: 'db://TABLE_NAME'
• dummy: 'dummy://'
• file: 'file:///PATH/TO/FILE'
• memcached: 'memcached://HOST:PORT' [#memcache]_
• pymemcached: 'pymemcached://HOST:PORT' For use with the python-memcached_ library. Useful if you're using Ubuntu <= 10.04.
• pymemcache: 'pymemcache://HOST:PORT' For use with the pymemcache_ library.
• djangopylibmc: 'djangopylibmc://HOST:PORT' For use with SASL based setups such as Heroku.
• redis: 'redis://[USER:PASSWORD@]HOST:PORT[/DB]' or 'redis:///PATH/TO/SOCKET[/DB]' For use with django-redis. To use django-redis-cache just add ?lib=redis-cache to the URL.
• rediss: 'rediss://[USER:PASSWORD@]HOST:PORT[/DB]' For use with django-redis_.
• hiredis: 'hiredis://[USER:PASSWORD@]HOST:PORT[/DB]' or 'hiredis:///PATH/TO/SOCKET[/DB]' For use with django-redis library using HiredisParser.
• uwsgicache: 'uwsgicache://[CACHENAME]' For use with django-uwsgi-cache_. Fallbacks to locmem if not running on uWSGI server.

All cache urls support optional cache arguments by using a query string, e.g.: 'memcached://HOST:PORT?key_prefix=site1'. See the Django cache arguments documentation_.

.. [#memcache] To specify multiple instances, separate the the HOST:PORT``` pair by commas, e.g: 'memcached://HOST1:PORT1,HOST2:PORT2``

.. _django-redis: https://github.com/niwibe/django-redis .. _django-redis-cache: https://github.com/sebleier/django-redis-cache .. _python-memcached: https://github.com/linsomniac/python-memcached .. _pymemcache: https://github.com/pinterest/pymemcache .. _cache arguments documentation: https://docs.djangoproject.com/en/dev/topics/cache/#cache-arguments .. _django-uwsgi-cache: https://github.com/ionelmc/django-uwsgi-cache

Installation

Installation is simple too::

$ pip install django-cache-url

Tests

To run the tests install tox::

pip install tox

Then run them with::

make test