Skip to content

D
Django-Redis-Cache
Commit 32476856 authored by Sean Bleier's avatar Sean Bleier
Browse files
Options

Merge pull request #90 from sebleier/docs 

Docs
parents 6ec2fd72 5428bfb0
Hide whitespace changes
Inline Side-by-side
Showing with 1016 additions and 0 deletions
README.rst
View file @ 32476856
......@@ -16,6 +16,8 @@ Redis Django Cache Backend
A Redis cache backend for Django
Docs can be found at `http://django-redis-cache.readthedocs.org/en/latest/`_.
Changelog
=========
......@@ -250,6 +252,7 @@ Running Tests
=============
``./install_redis.sh``
``make test``
.. _redis-py: http://github.com/andymccurdy/redis-py/
......
docs/Makefile 0 → 100644
View file @ 32476856
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-redis-cache.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-redis-cache.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/django-redis-cache"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-redis-cache"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
docs/advanced_configuration.rst 0 → 100644
View file @ 32476856
Advanced Configuration
**********************
Example Setting
---------------
.. code:: python
CACHES = {
'default': {
'BACKEND': 'redis_cache.RedisCache',
'LOCATION': '127.0.0.1:6379',
'OPTIONS': {
'DB': 1,
'PASSWORD': 'yadayada',
'PARSER_CLASS': 'redis.connection.HiredisParser',
'CONNECTION_POOL_CLASS': 'redis.BlockingConnectionPool',
'PICKLE_VERSION': -1,
},
},
}
Pluggable Backends
------------------
django-redis-cache comes with a couple pluggable backends, one for a unified
keyspace and one for a sharded keyspace. The former can be in the form of a
single redis server or several redis servers setup in a primary/secondary
configuration. The primary is used for writing and secondaries are
replicated versions of the primary for read-access.
.. code:: python
# Unified keyspace
CACHES = {
'default': {
'BACKEND': 'redis_cache.RedisCache',
...
}
}
# Sharded keyspace
CACHES = {
'default': {
'BACKEND': 'redis_cache.ShardedRedisCache',
...
}
}
Location Schemes
----------------
The ``LOCATION`` contains the information for the redis server's location,
which can be the address/port or the server path to the unix domain socket. The
location can be a single string or a list of strings. Several schemes for
defining the location can be used. Here is a list of example schemes:
* ``127.0.0.1:6379``
* ``/path/to/socket``
* ``redis://[:password]@localhost:6379/0``
* ``rediss://[:password]@localhost:6379/0``
* ``unix://[:password]@/path/to/socket.sock?db=0``
Database Number
---------------
The ``DB`` option will allow key/values to exist in a different keyspace. The
``DB`` value can either be defined in the ``OPTIONS`` or in the ``LOCATION``
scheme.
.. code:: python
CACHES = {
'default': {
'OPTIONS': {
'DB': 1,
..
},
...
}
}
Password
--------
If the redis server is password protected, you can specify the ``PASSWORD``
option.
.. code:: python
CACHES = {
'default': {
'OPTIONS': {
'PASSWORD': 'yadayada',
...
},
...
}
}
Pluggable Parse Classes
-----------------------
`redis-py`_ comes with two parsers: ``HiredisParser`` and ``PythonParser``.
The former uses the `hiredis`_ library to parse responses from the redis
server, while the latter uses Python. Hiredis is a library that uses C, so it
is much faster than the python parser, but requires installing the library
separately.
To install `hiredis`_:
``pip install hiredis``
.. code:: python
CACHES = {
'default': {
'OPTIONS': {
'PARSER_CLASS': 'redis.connection.HiredisParser',
...
},
...
}
}
Pickle Version
--------------
When using the pickle serializer, you can use ``PICKLE_VERSION`` to specify
the protocol version of pickle you want to use to serialize your python objects.
.. code:: python
CACHES = {
'default': {
'OPTIONS': {
'PICKLE_VERSION': 2,
...
},
...
},
}
Socket Timeout and Socket Create Timeout
----------------------------------------
When working with a TCP connection, it may be beneficial to set the
``SOCKET_TIMEOUT`` and ``SOCKET_CONNECT_TIMEOUT`` options to prevent your
app from blocking indefinitely.
If provided, the socket will time out when the established connection exceeds
``SOCKET_TIMEOUT`` seconds.
Similarly, the socket will time out if it takes more than
``SOCKET_CONNECT_TIMEOUT`` seconds to establish.
.. code:: python
CACHES={
'default': {
'OPTIONS': {
'SOCKET_TIMEOUT': 5,
'SOCKET_CONNECT_TIMEOUT': 5,
...
}
...
}
}
Connection Pool
---------------
There is an associated overhead when creating connections to a redis server.
Therefore, it's beneficial to create a pool of connections that the cache can
reuse to send or retrieve data from the redis server.
``CONNECTION_POOL_CLASS`` can be used to specify a class to use for the
connection pool. In addition, you can provide custom keyword arguments using
the ``CONNECTION_POOL_CLASS_KWARGS`` option that will be passed into the class
when it's initialized.
.. code:: python
CACHES = {
'default': {
'OPTIONS': {
'CONNECTION_POOL_CLASS': 'redis.BlockingConnectionPool',
'CONNECTION_POOL_CLASS_KWARGS': {
'max_connections': 50,
'timeout': 20,
...
},
...
},
...
}
}
Pluggable Serializers
---------------------
You can use ``SERIALIZER_CLASS`` to specify a class that will
serialize/deserialize data. In addition, you can provide custom keyword
arguments using the ``SERIALIZER_CLASS_KWARGS`` option that will be passed into
the class when it's initialized.
The default serializer in django-redis-cache is the pickle serializer. It can
serialize most python objects, but is slow and not always safe. Also included
are serializer using json, msgpack, and yaml. Not all serializers can handle
Python objects, so they are limited to primitive data types.
.. code:: python
CACHES = {
'default': {
'OPTIONS': {
'SERIALIZER_CLASS': 'redis_cache.serializers.PickleSerializer',
'SERIALIZER_CLASS_KWARGS': {
'pickle_version': -1
},
...
},
...
}
}
Pluggable Compressors
---------------------
You can use ``COMPRESSOR_CLASS`` to specify a class that will
compress/decompress data. Use the ``COMPRESSOR_CLASS_KWARGS`` option to
initialize the compressor class.
The default compressor is ``NoopCompressor`` which does not compress your data.
However, if you want to compress your data, you can use one of the included
compressor classes:
.. code:: python
# zlib compressor
CACHES = {
'default': {
'OPTIONS': {
'COMPRESSOR_CLASS': 'redis_cache.compressors.ZLibCompressor',
'COMPRESSOR_CLASS_KWARGS': {
'level': 5, # 0 - 9; 0 - no compression; 1 - fastest, biggest; 9 - slowest, smallest
},
...
},
...
}
}
# bzip2 compressor
CACHES = {
'default': {
'OPTIONS': {
'COMPRESSOR_CLASS': 'redis_cache.compressors.BZip2Compressor',
'COMPRESSOR_CLASS_KWARGS': {
'compresslevel': 5, # 1 - 9; 1 - fastest, biggest; 9 - slowest, smallest
},
...
},
...
}
}
.. _redis-py: http://github.com/andymccurdy/redis-py/
.. _hiredis: https://pypi.python.org/pypi/hiredis/
docs/api.rst 0 → 100644
View file @ 32476856
API Usage
*********
Standard Django Cache API
-------------------------
.. function:: get(self, key[, default=None]):
Retrieves a value from the cache.
:param key: Location of the value
:param default: Value to return if key does not exist in cache.
:rtype: Value what was cached.
.. function:: add(self, key, value[, timeout=None]):
Add a value to the cache, failing if the key already exists.
:param key: Location of the value
:param value: Value to cache
:param timeout: Number of seconds to hold value in cache.
:type timeout: Number of seconds or None
:rtype: True if object was added and False if it already exists.
.. function:: set(self, key, value, timeout=DEFAULT_TIMEOUT):
Sets a value to the cache, regardless of whether it exists.
If ``timeout == None``, then cache is set indefinitely. Otherwise, timeout defaults to the defined ``DEFAULT_TIMEOUT``.
:param key: Location of the value
:param value: Value to cache
:param timeout: Number of seconds to hold value in cache.
:type timeout: Number of seconds or None
.. function:: delete(self, key):
Removes a key from the cache
:param key: Location of the value
.. function:: delete_many(self, keys[, version=None]):
Removes multiple keys at once.
:param key: Location of the value
:param version: Version of keys
.. function:: clear(self[, version=None]):
Flushes the cache. If version is provided, all keys under the version number will be deleted. Otherwise, all keys will be flushed.
:param version: Version of keys
.. function:: get_many(self, keys[, version=None]):
Retrieves many keys at once.
:param keys: an iterable of keys to retrieve.
:rtype: Dict of keys mapping to their values.
.. function:: set_many(self, data[, timeout=None, version=None]):
Set many values in the cache at once from a dict of key/value pairs. This is much more efficient than calling set() multiple times and is atomic.
:param data: dict of key/value pairs to cache.
:param timeout: Number of seconds to hold value in cache.
:type timeout: Number of seconds or None
.. function:: incr(self, key[, delta=1]):
Add delta to value in the cache. If the key does not exist, raise a `ValueError` exception.
:param key: Location of the value
:param delta: Integer used to increment a value.
:type delta: Integer
.. function:: incr_version(self, key[, delta=1, version=None]):
Adds delta to the cache version for the supplied key. Returns the new version.
:param key: Location of the value
:param delta: Integer used to increment a value.
:type delta: Integer
:param version: Version of key
:type version: Integer or None
Cache Methods Provided by django-redis-cache
--------------------------------------------
.. function:: has_key(self, key):
Returns True if the key is in the cache and has not expired.
:param key: Location of the value
:rtype: bool
.. function:: ttl(self, key):
Returns the 'time-to-live' of a key. If the key is not volatile, i.e. it has not set an expiration, then the value returned is None.
Otherwise, the value is the number of seconds remaining. If the key does not exist, 0 is returned.
:param key: Location of the value
:rtype: Integer or None
.. function:: delete_pattern(pattern[, version=None]):
Deletes keys matching the glob-style pattern provided.
:param pattern: Glob-style pattern used to select keys to delete.
:param version: Version of the keys
.. function:: get_or_set(self, key, func[, timeout=None]):
Retrieves a key value from the cache and sets the value if it does not exist.
:param key: Location of the value
:param func: Callable used to set the value if key does not exist.
:param timeout: Number of seconds to hold value in cache.
:type timeout: Number of seconds or None
.. function:: reinsert_keys(self):
Helper function to reinsert keys using a different pickle protocol version.
.. function:: persist(self, key):
Removes the timeout on a key.
Equivalent to setting a timeout of None in a set command.
:param key: Location of the value
:rtype: bool
.. function:: expire(self, key, timeout):
Set the expire time on a key
:param key: Location of the value
:rtype: bool
docs/conf.py 0 → 100644
View file @ 32476856
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# django-redis-cache documentation build configuration file, created by
# sphinx-quickstart on Mon Jul 20 10:08:24 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
import shlex
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'django-redis-cache'
copyright = '2015, Sean Bleier'
author = 'Sean Bleier'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.5.2'
# The full version, including alpha/beta/rc tags.
release = '1.5.2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
#html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'django-redis-cachedoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
#'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'django-redis-cache.tex', 'django-redis-cache Documentation',
'Sean Bleier', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'django-redis-cache', 'django-redis-cache Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'django-redis-cache', 'django-redis-cache Documentation',
author, 'django-redis-cache', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
docs/index.rst 0 → 100644
View file @ 32476856
.. django-redis-cache documentation master file, created by
sphinx-quickstart on Mon Jul 20 10:08:24 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to django-redis-cache's documentation!
==============================================
Contents:
.. toctree::
:maxdepth: 2
intro_quick_start
api
advanced_configuration
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs/intro_quick_start.rst 0 → 100644
View file @ 32476856
Intro and Quick Start
*********************
Intro
=====
`django-redis-cache`_ is a cache backend for the `Django`_ webframework. It
uses the `redis`_ server, which is a in-memory key-value data structure server.
Similar to the great `Memcached`_ in performance, it has several features that
makes it more appealing.
* Multiple data structures types, e.g. string, list, set, sorted sets, and hashes.
* Atomic pipelines: guaranteed that multiple commands will run sequentially and uninterrupted.
* Pub/Sub: subscribe to a channel and listen for messages from other processes.
* Can back data to disk, which can keep a cache warm even if the process is killed.
* Lua scripting
* Clustering (as of 3.0)
* Many more.
Many of these features are irrelevant to caching, but can be used by other
areas of a web stack and therefore offer a compelling case to simplify your
infrastructure.
Quick Start
===========
**Recommended:**
* `redis`_ >= 2.4
* `redis-py`_ >= 2.10.3
* `python`_ >= 2.7
1. Install `redis`_. You can use ``install_redis.sh`` to install a local copy
of redis. Start the server by running ``./src/redis-server``
2. Run ``pip install django-redis-cache``.
3. Modify your Django settings to use ``redis_cache``.
.. code:: python
CACHES = {
'default': {
'BACKEND': 'redis_cache.RedisCache',
'LOCATION': 'localhost:6379',
},
}
.. _Django: https://www.djangoproject.com/
.. _django-redis-cache: http://github.com/sebleier/django-redis-cache
.. _redis-py: http://github.com/andymccurdy/redis-py/
.. _redis: http://github.com/antirez/redis/
.. _python: http://python.org
.. _Memcached: http://memcached.org
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment