Creates a Sphinx documentation.
This commit is contained in:
Bertrand Bordage
parent
bc31429394
commit
d36ee841b9
|
|
@ -6,3 +6,4 @@ dist/
|
|||
sdist/
|
||||
*.egg-info/
|
||||
.coverage
|
||||
docs/_*/
|
||||
|
|
|
|||
|
|
@ -0,0 +1,177 @@
|
|||
# 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 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 " 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)"
|
||||
|
||||
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-cachalot.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-cachalot.qhc"
|
||||
|
||||
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-cachalot"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-cachalot"
|
||||
@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."
|
||||
|
||||
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."
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
.. _API:
|
||||
|
||||
API
|
||||
---
|
||||
|
||||
Use these tools if the automatic behaviour of django-cachalot is not enough.
|
||||
Typically, use ``invalidate_tables`` or ``invalidate_models`` after each raw
|
||||
SQL query modifying the database.
|
||||
|
||||
.. automodule:: cachalot.api
|
||||
:members:
|
||||
|
|
@ -0,0 +1,275 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# django-cachalot documentation build configuration file, created by
|
||||
# sphinx-quickstart on Tue Oct 28 22:46:50 2014.
|
||||
#
|
||||
# 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
|
||||
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
import cachalot
|
||||
|
||||
# This sets up Django, necessary for autodoc
|
||||
import runtests
|
||||
|
||||
# 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 = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.ifconfig',
|
||||
'sphinx.ext.viewcode',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
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-cachalot'
|
||||
copyright = '2014, Bertrand Bordage'
|
||||
|
||||
# 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 = '%s.%s' % cachalot.__version__[:2]
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = cachalot.version_string
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#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
|
||||
|
||||
|
||||
# -- 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 = 'default'
|
||||
|
||||
# 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
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'django-cachalotdoc'
|
||||
|
||||
|
||||
# -- 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': '',
|
||||
}
|
||||
|
||||
# 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 = [
|
||||
('index', 'django-cachalot.tex', u'django-cachalot Documentation',
|
||||
u'Bertrand Bordage', '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 = [
|
||||
('index', 'django-cachalot', u'django-cachalot Documentation',
|
||||
[u'Bertrand Bordage'], 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 = [
|
||||
('index', 'django-cachalot', u'django-cachalot Documentation',
|
||||
u'Bertrand Bordage', 'django-cachalot', '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
|
||||
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
How django-cachalot works
|
||||
-------------------------
|
||||
|
||||
**(If you don’t care/understand, just pretend it’s magic)**
|
||||
|
||||
Reverse engineering
|
||||
...................
|
||||
|
||||
It’s a lot of Django reverse engineering combined with a strong test suite.
|
||||
Such a test suite is crucial for a reverse engineering project.
|
||||
If some important part of Django changes and breaks the expected behaviour,
|
||||
you can be sure that the test suite will fail.
|
||||
|
||||
Monkey patching
|
||||
...............
|
||||
|
||||
django-cachalot modifies Django in place during execution to add a caching tool
|
||||
just before SQL queries are executed.
|
||||
We detect which cache keys must be removed when some data
|
||||
is created/changed/deleted on the database.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
***************
|
||||
django-cachalot
|
||||
***************
|
||||
|
||||
Caches your Django ORM queries and automatically invalidates them.
|
||||
|
||||
.. image:: https://raw.github.com/BertrandBordage/django-cachalot/master/django-cachalot.jpg
|
||||
|
||||
Project status:
|
||||
|
||||
**Currently in beta, do not use in production**
|
||||
|
||||
.. image:: http://img.shields.io/pypi/v/django-cachalot.svg?style=flat-square
|
||||
:target: https://pypi.python.org/pypi/django-cachalot
|
||||
|
||||
.. image:: http://img.shields.io/travis/BertrandBordage/django-cachalot/master.svg?style=flat-square
|
||||
:target: https://travis-ci.org/BertrandBordage/django-cachalot
|
||||
|
||||
.. image:: http://img.shields.io/coveralls/BertrandBordage/django-cachalot/master.svg?style=flat-square
|
||||
:target: https://coveralls.io/r/BertrandBordage/django-cachalot?branch=master
|
||||
|
||||
.. image:: http://img.shields.io/scrutinizer/g/BertrandBordage/django-cachalot/master.svg?style=flat-square
|
||||
:target: https://scrutinizer-ci.com/g/BertrandBordage/django-cachalot/
|
||||
|
||||
.. image:: http://img.shields.io/gratipay/BertrandBordage.svg?style=flat-square
|
||||
:target: https://gratipay.com/BertrandBordage/
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
quickstart
|
||||
limits
|
||||
api
|
||||
todo
|
||||
reporting
|
||||
how
|
||||
legacy
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
Legacy
|
||||
------
|
||||
|
||||
This work is highly inspired of
|
||||
`johnny-cache <https://github.com/jmoiron/johnny-cache>`_, another easy-to-use
|
||||
ORM caching tool! It’s working with Django <= 1.5.
|
||||
I used it in production during 3 years, it’s an excellent module!
|
||||
|
||||
Unfortunately, we failed to make it migrate to Django 1.6 (I was involved).
|
||||
It was mostly because of the transaction system that was entirely refactored.
|
||||
|
||||
I also noticed a few advanced invalidation issues when using ``QuerySet.extra``
|
||||
and some complex cases implying multi-table inheritance
|
||||
and related ``ManyToManyField``.
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
.. _limits:
|
||||
|
||||
Limits
|
||||
------
|
||||
|
||||
Locmem
|
||||
......
|
||||
|
||||
Locmem is a just a dict stored in a single Python process.
|
||||
It’s not shared between processes, so don’t use locmem with django-cachalot
|
||||
in a multi-processes project, if you use RQ or Celery for instance.
|
||||
|
||||
Raw queries
|
||||
...........
|
||||
|
||||
Django-cachalot doesn’t cache queries it can’t reliably invalidate.
|
||||
If a SQL query or a part of it is written in pure SQL, it won’t be cached.
|
||||
That’s why ``QuerySet.extra`` with ``select`` or ``where`` arguments,
|
||||
``Model.objects.raw(…)``, & ``cursor.execute(…)`` queries are not cached.
|
||||
|
||||
If you modify the database using a raw query, **you will have to manually
|
||||
invalidate** django-cachalot using one of the tools available in :ref:`the API <API>`.
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
Quick start
|
||||
-----------
|
||||
|
||||
Requirements
|
||||
............
|
||||
|
||||
- Django 1.6 or 1.7
|
||||
- Python 2.6, 2.7, 3.2, 3.3, or 3.4
|
||||
- `django-redis <https://github.com/niwibe/django-redis>`_,
|
||||
`memcached <https://docs.djangoproject.com/en/1.7/topics/cache/#memcached>`_
|
||||
(or `locmem <https://docs.djangoproject.com/en/1.7/topics/cache/#local-memory-caching>`_,
|
||||
but it’s not shared between processes, so don’t use it with RQ or Celery)
|
||||
- PostgreSQL, MySQL or SQLite
|
||||
|
||||
Usage
|
||||
.....
|
||||
|
||||
#. ``pip install django-cachalot``
|
||||
#. Add ``'cachalot',`` to your ``INSTALLED_APPS``
|
||||
#. Be aware of :ref:`the few limits <limits>`
|
||||
#. Enjoy!
|
||||
|
||||
|
||||
Settings
|
||||
........
|
||||
|
||||
==================== ============= ============================================
|
||||
Setting Default value Description
|
||||
==================== ============= ============================================
|
||||
``CACHALOT_ENABLED`` ``True`` If set to ``False``, disables SQL caching
|
||||
but keeps invalidating to avoid stale cache
|
||||
``CACHALOT_CACHE`` ``'default'`` Alias of the cache from |CACHES|_ used by
|
||||
django-cachalot
|
||||
==================== ============= ============================================
|
||||
|
||||
.. |CACHES| replace:: ``CACHES``
|
||||
.. _CACHES: https://docs.djangoproject.com/en/1.7/ref/settings/#std:setting-CACHES
|
||||
|
||||
These settings can be changed whenever you want.
|
||||
You have to use ``cachalot_settings`` as a context manager, a decorator,
|
||||
or simply by changing its attributes:
|
||||
|
||||
.. code:: python
|
||||
|
||||
from cachalot.settings import cachalot_settings
|
||||
|
||||
with cachalot_settings(CACHALOT_ENABLED=False):
|
||||
# SQL queries are not cached in this block
|
||||
|
||||
@cachalot_settings(CACHALOT_CACHE='another_alias')
|
||||
def your_function():
|
||||
# What’s in this function uses another cache
|
||||
|
||||
# Globally disables SQL caching until you set it back to True
|
||||
cachalot_settings.CACHALOT_ENABLED = False
|
||||
|
||||
In tests, you can use
|
||||
`Django’s testing tools <https://docs.djangoproject.com/en/1.7/topics/testing/tools/#overriding-settings>`_
|
||||
as well as ``cachalot_settings``. The only difference is that you can’t use
|
||||
``cachalot_settings`` to decorate a class.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
Bug reports, questions, discussion, new features
|
||||
------------------------------------------------
|
||||
|
||||
- If you spotted **a bug**, please file a precise bug report
|
||||
`on GitHub <https://github.com/BertrandBordage/django-cachalot/issues>`_
|
||||
- If you have **a question** on how django-cachalot works or to **simply
|
||||
discuss**, `go to our Google group
|
||||
<https://groups.google.com/forum/#!forum/django-cachalot>`_.
|
||||
- If you want **to add a feature**:
|
||||
|
||||
- if you have an idea on how to implement it, you can fork the project
|
||||
and send a pull request, but **please open an issue first**, because
|
||||
someone else could already be working on it
|
||||
- if you’re sure that it’s a must-have feature, open an issue
|
||||
- if it’s just a vague idea, please ask on google groups before
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
What still needs to be done
|
||||
---------------------------
|
||||
|
||||
For version 1.0
|
||||
...............
|
||||
|
||||
- Test if a stale cache issue happens when a table is invalidated
|
||||
exactly during a SQL read query
|
||||
- Write tests for `multi-table inheritance <https://docs.djangoproject.com/en/1.7/topics/db/models/#multi-table-inheritance>`_
|
||||
- Test if code injections can occur when unpickling query results
|
||||
(or use a safer serialization tool)
|
||||
|
||||
In a more distant future
|
||||
........................
|
||||
|
||||
- Add a setting to choose if we cache ``QuerySet.order_by('?')``
|
||||
- Use ``connection.introspection.table_names()`` to detect which tables
|
||||
are implied in a ``QuerySet.extra``
|
||||
|
|
@ -63,11 +63,11 @@ settings.configure(
|
|||
PASSWORD_HASHERS=('django.contrib.auth.hashers.MD5PasswordHasher',),
|
||||
)
|
||||
|
||||
if django.VERSION[:2] >= (1, 7):
|
||||
django.setup()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
if django.VERSION[:2] >= (1, 7):
|
||||
django.setup()
|
||||
|
||||
from django.test.runner import DiscoverRunner
|
||||
test_runner = DiscoverRunner()
|
||||
failures = test_runner.run_tests(['cachalot.tests'])
|
||||
|
|
|
|||
Loading…
Reference in New Issue