[Python-modules-commits] [django-dirtyfields] 01/04: import django-dirtyfields_1.2.1.orig.tar.gz
Christopher Stuart Hoskin
mans0954 at moszumanska.debian.org
Sun Mar 5 22:12:56 UTC 2017
This is an automated email from the git hooks/post-receive script.
mans0954 pushed a commit to branch master
in repository django-dirtyfields.
commit d6b1c7dd40931650ee89b451fd544c42efc3b91d
Author: Christopher Hoskin <christopher.hoskin at gmail.com>
Date: Sun Mar 5 20:52:34 2017 +0000
import django-dirtyfields_1.2.1.orig.tar.gz
---
.gitignore | 10 ++
.travis.yml | 50 ++++++
AUTHORS | 2 +
CLASSIFIERS.txt | 11 ++
ChangeLog.rst | 186 ++++++++++++++++++++++
LICENSE | 17 ++
MANIFEST.in | 4 +
README.rst | 76 +++++++++
docs/Makefile | 192 +++++++++++++++++++++++
docs/_ext/djangodocs.py | 28 ++++
docs/conf.py | 299 ++++++++++++++++++++++++++++++++++++
docs/contributing.rst | 9 ++
docs/credits.rst | 6 +
docs/index.rst | 195 +++++++++++++++++++++++
pytest.ini | 3 +
requirements.txt | 2 +
setup.py | 21 +++
src/dirtyfields/__init__.py | 2 +
src/dirtyfields/compare.py | 58 +++++++
src/dirtyfields/compat.py | 72 +++++++++
src/dirtyfields/dirtyfields.py | 131 ++++++++++++++++
tests/__init__.py | 0
tests/compat.py | 8 +
tests/django_settings.py | 16 ++
tests/models.py | 119 ++++++++++++++
tests/postgresql_django_settings.py | 16 ++
tests/test_core.py | 155 +++++++++++++++++++
tests/test_json_field.py | 29 ++++
tests/test_m2m_fields.py | 53 +++++++
tests/test_non_regression.py | 147 ++++++++++++++++++
tests/test_postgresql_specific.py | 22 +++
tests/test_save_fields.py | 69 +++++++++
tests/test_timezone_aware_fields.py | 55 +++++++
tests/utils.py | 68 ++++++++
tox.ini | 64 ++++++++
35 files changed, 2195 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1afc366
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+*.pyc
+ve
+*.egg-info
+*.db
+docs/_build/*
+docs/_template/*
+docs/_static/*
+.tox
+.cache
+.coverage
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..bc8e8ca
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,50 @@
+language: python
+
+python:
+ - 2.7
+ - 3.4
+
+env:
+ - TOXENV=django14
+ - TOXENV=django15
+ - TOXENV=django16
+ - TOXENV=django17
+ - TOXENV=django18
+ - TOXENV=django19
+ - TOXENV=django110
+ - TOXENV=coverage
+ - TOXENV=postgresql
+
+matrix:
+ exclude:
+ - python: 3.4
+ env: TOXENV=django14
+
+services:
+ - postgresql
+
+addons:
+ postgresql: "9.4"
+
+before_script:
+ - psql -c 'create database dirtyfields_test;' -U postgres
+
+script:
+ - tox
+
+install:
+ - pip install tox
+ - pip install coveralls
+ - pip install -e .
+
+after_success:
+ - if test "$TOXENV" = "coverage"; then coveralls; fi
+
+deploy:
+ provider: pypi
+ user: smn
+ password:
+ secure: "sXlDQNG8p+F4y8TKbRVw44uBCzECecgWQLNYcJBObMPoPbp64Ux488kM5RhbYhof0H1W850CKZzW66GQAjay0HS8tp9nPXg35xInPongLFuPzapoOdHtJZa5ub9QnpIs6LifJ/zXP5YDqh8ZUyoD+oFMvMFKjBkVB/NIYMYkyEM="
+ on:
+ tags: true
+ all_branches: true
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..38404c6
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,2 @@
+Romain Garrigues <romain.garrigues.cs at gmail.com>
+Simon de Haan <simon at praekeltfoundation.org>
diff --git a/CLASSIFIERS.txt b/CLASSIFIERS.txt
new file mode 100644
index 0000000..44b13f3
--- /dev/null
+++ b/CLASSIFIERS.txt
@@ -0,0 +1,11 @@
+Development Status :: 5 - Production/Stable
+Intended Audience :: Developers
+License :: OSI Approved :: BSD License
+Operating System :: OS Independent
+Programming Language :: Python
+Programming Language :: Python :: 2
+Programming Language :: Python :: 2.7
+Programming Language :: Python :: 3
+Programming Language :: Python :: 3.4
+Framework :: Django
+Topic :: Software Development :: Libraries :: Python Modules
diff --git a/ChangeLog.rst b/ChangeLog.rst
new file mode 100644
index 0000000..00f2afb
--- /dev/null
+++ b/ChangeLog.rst
@@ -0,0 +1,186 @@
+ChangeLog
+=========
+
+
+.. _v1.2.1:
+
+1.2.1 (2016-11-16)
+------------------
+
+*New:*
+
+ - :code:`django-dirtyfields` is now tested with PostgreSQL, especially with specific fields
+ - Fixes #80: Use of :code:`Field.rel` raises warnings from Django 1.9+
+ - Fixes #84: Use :code:`only()` in conjunction with 2 foreign keys triggers a recursion error
+ - Fixes #77: Shallow copy does not work with Django 1.9's JSONField
+ - Fixes #88: :code:`get_dirty_fields` on a newly-created model does not work if pk is specified
+ - Fixes #90: Unmark dirty fields only listed in :code:`update_fields`
+
+
+.. _v1.2:
+
+1.2 (2016-08-11)
+----------------
+
+*New:*
+
+ - :code:`django-dirtyfields` is now compatible with Django 1.10 series (deferred field handling has been updated).
+
+
+.. _v1.1:
+
+1.1 (2016-08-04)
+----------------
+
+*New:*
+
+ - A new attribute :code:`ENABLE_M2M_CHECK` has been added to :code:`DirtyFieldsMixin` to enable/disable m2m check
+ functionality. This parameter is set to :code:`False` by default.
+ IMPORTANT: backward incompatibility with v1.0.x series. If you were using :code:`check_m2m` parameter to
+ check m2m relations, you should now add :code:`ENABLE_M2M_CHECK = True` to these models inheriting from
+ :code:`DirtyFieldsMixin`. Check the documentation to see more details/examples.
+
+
+.. _v1.0.1:
+
+1.0.1 (2016-07-25)
+------------------
+
+*bugfix:*
+
+ - Fixing a bug preventing :code:`django-dirtyfields` to work properly on models with custom primary keys.
+
+
+.. _v1.0:
+
+1.0 (2016-06-26)
+----------------
+
+After several years of existence, django-dirty-fields is mature enough to switch to 1.X version.
+There is a backward-incompatibility on this version. Please read careful below.
+
+*New:*
+
+ - IMPORTANT: :code:`get_dirty_fields` is now more consistent for models not yet saved in the database.
+ :code:`get_dirty_fields` is, in that situation, always returning ALL fields, where it was before returning
+ various results depending on how you initialised your model.
+ It may affect you specially if you are using :code:`get_dirty_fields` in a :code:`pre_save` receiver.
+ See more details at https://github.com/romgar/django-dirtyfields/issues/65.
+ - Adding compatibility for old _meta API, deprecated in Django `1.10` version and now replaced by an official API.
+ - General test cleaning.
+
+
+.. _v0.9:
+
+0.9 (2016-06-18)
+----------------
+
+*New:*
+
+ - Adding Many-to-Many fields comparison method :code:`check_m2m` in :code:`DirtyFieldsMixin`.
+ - Adding :code:`verbose` parameter in :code:`get_dirty_fields` method to get old AND new field values.
+
+
+.. _v0.8.2:
+
+0.8.2 (2016-03-19)
+------------------
+
+*New:*
+
+ - Adding field comparison method :code:`compare_function` in :code:`DirtyFieldsMixin`.
+ - Also adding a specific comparison function :code:`timezone_support_compare` to handle different Datetime situations.
+
+
+.. _v0.8.1:
+
+0.8.1 (2015-12-08)
+------------------
+
+*bugfix:*
+
+ - Not comparing fields that are deferred (:code:`only` method on :code:`QuerySet`).
+ - Being more tolerant when comparing values that can be on another type than expected.
+
+
+
+.. _v0.8:
+
+0.8 (2015-10-30)
+----------------
+
+*New:*
+
+ - Adding :code:`save_dirty_fields` method to save only dirty fields in the database.
+
+
+.. _v0.7:
+
+0.7 (2015-06-18)
+----------------
+
+*New:*
+
+ - Using :code:`copy` to properly track dirty fields on complex fields.
+ - Using :code:`py.test` for tests launching.
+
+
+.. _v0.6.1:
+
+0.6.1 (2015-06-14)
+------------------
+
+*Bugfix:*
+
+ - Preventing django db expressions to be evaluated when testing dirty fields (#39).
+
+
+.. _v0.6:
+
+0.6 (2015-06-11)
+----------------
+
+*New:*
+
+ - Using :code:`to_python` to avoid false positives when dealing with model fields that internally convert values (#4)
+
+*Bugfix:*
+
+ - Using :code:`attname` instead of :code:`name` on fields to avoid massive useless queries on ForeignKey fields (#34). For this kind of field, :code:`get_dirty_fields()` is now returning instance id, instead of instance itself.
+
+
+.. _v0.5:
+
+0.5 (2015-05-06)
+----------------
+
+*New:*
+
+ - Adding code compatibility for python3,
+ - Launching travis-ci tests on python3,
+ - Using :code:`tox` to launch tests on Django 1.5, 1.6, 1.7 and 1.8 versions,
+ - Updating :code:`runtests.py` test script to run properly on every Django version.
+
+*Bugfix:*
+
+ - Catching :code:`Error` when trying to get foreign key object if not existing (#32).
+
+
+.. _v0.4.1:
+
+0.4.1 (2015-04-08)
+------------------
+
+*Bugfix:*
+
+ - Removing :code:`model_to_form` to avoid bug when using models that have :code:`editable=False` fields.
+
+
+.. _v0.4:
+
+0.4 (2015-03-31)
+----------------
+
+*New:*
+
+ - Adding :code:`check_relationship` parameter on :code:`is_dirty` and :code:`get_dirty_field` methods to also check foreign key values.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..937e0d1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,17 @@
+Copyright (c) Praekelt Foundation and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of the Praekelt Foundation nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROF [...]
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..c9f28d8
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,4 @@
+include LICENSE
+include README.rst
+include CLASSIFIERS.txt
+include requirements.txt
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..35b656b
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,76 @@
+===================
+Django Dirty Fields
+===================
+
+.. image:: https://badges.gitter.im/Join%20Chat.svg
+ :alt: Join the chat at https://gitter.im/romgar/django-dirtyfields
+ :target: https://gitter.im/romgar/django-dirtyfields?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+.. image:: https://travis-ci.org/romgar/django-dirtyfields.svg?branch=develop
+ :target: https://travis-ci.org/romgar/django-dirtyfields?branch=develop
+.. image:: https://coveralls.io/repos/romgar/django-dirtyfields/badge.svg?branch=develop
+ :target: https://coveralls.io/r/romgar/django-dirtyfields?branch=develop
+.. image:: http://readthedocs.org/projects/django-dirtyfields/badge/?version=develop
+ :target: http://django-dirtyfields.readthedocs.org/en/develop/?badge=develop
+
+Tracking dirty fields on a Django model instance.
+Dirty means that field in-memory and database values are different.
+
+This package is compatible and tested with Django 1.4 to 1.10.
+
+`Full documentation <http://django-dirtyfields.readthedocs.org/en/develop/>`_
+
+Install
+=======
+
+::
+
+ $ pip install django-dirtyfields
+
+
+Usage
+=====
+
+To use ``django-dirtyfields``, you need to:
+
+- Inherit from ``DirtyFieldMixin`` in the Django model you want to track.
+
+::
+
+ from django.db import models
+ from dirtyfields import DirtyFieldsMixin
+
+ class TestModel(DirtyFieldsMixin, models.Model):
+ """A simple test model to test dirty fields mixin with"""
+ boolean = models.BooleanField(default=True)
+ characters = models.CharField(blank=True, max_length=80)
+
+- Use one of these 2 functions on a model instance to know if this instance is dirty, and get the dirty fields:
+
+ * is\_dirty()
+ * get\_dirty\_fields()
+
+
+Example
+-------
+
+::
+
+ >>> from tests.models import TestModel
+ >>> tm = TestModel.objects.create(boolean=True,characters="testing")
+ >>> tm.is_dirty()
+ False
+ >>> tm.get_dirty_fields()
+ {}
+
+ >>> tm.boolean = False
+
+ >>> tm.is_dirty()
+ True
+ >>> tm.get_dirty_fields()
+ {'boolean': True}
+
+
+Consult the `full documentation <http://django-dirtyfields.readthedocs.org/en/develop/>`_ for more informations.
+
+
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..b9cf85a
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,192 @@
+# 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-dirtyfields.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-dirtyfields.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-dirtyfields"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-dirtyfields"
+ @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."
diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py
new file mode 100644
index 0000000..3fdb2dd
--- /dev/null
+++ b/docs/_ext/djangodocs.py
@@ -0,0 +1,28 @@
+
+def setup(app):
+ """
+ Mandatory to cross ref any non-default sphinx behaviours defined in Django
+ Thanks http://reinout.vanrees.org/weblog/2012/12/01/django-intersphinx.html
+ We can then use :django:settings:`ROOT_URLCONF` for example
+ (We then avoid ERROR: Unknown interpreted text role "django:settings")
+ """
+ app.add_crossref_type(
+ directivename="setting",
+ rolename="setting",
+ indextemplate="pair: %s; setting",
+ )
+ app.add_crossref_type(
+ directivename="templatetag",
+ rolename="ttag",
+ indextemplate="pair: %s; template tag"
+ )
+ app.add_crossref_type(
+ directivename="templatefilter",
+ rolename="tfilter",
+ indextemplate="pair: %s; template filter"
+ )
+ app.add_crossref_type(
+ directivename="fieldlookup",
+ rolename="lookup",
+ indextemplate="pair: %s; field lookup type",
+ )
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..2049d8b
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,299 @@
+# -*- coding: utf-8 -*-
+#
+# django-dirtyfields documentation build configuration file, created by
+# sphinx-quickstart on Wed Nov 18 20:17:31 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.
+
+sys.path.append(
+ os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
+
+extensions = [
+ 'djangodocs',
+ 'sphinx.ext.intersphinx'
+]
+
+# Added manually to reference other sphinx documentations
+intersphinx_mapping = {
+ 'python': ('http://docs.python.org/2.7', None),
+ 'sphinx': ('http://sphinx.pocoo.org/', None),
+ 'django': ('http://docs.djangoproject.com/en/dev/',
+ 'http://docs.djangoproject.com/en/dev/_objects/'),
+}
+
+# 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 = u'django-dirtyfields'
+copyright = u'2015, Romain Garrigues'
+author = u'Romain Garrigues'
+
+# 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 = '0.8.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.8.1'
+
+# 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', 'hu', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'ru', '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-dirtyfieldsdoc'
+
+# -- 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-dirtyfields.tex', u'django-dirtyfields Documentation',
+ u'Romain Garrigues', '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-dirtyfields', u'django-dirtyfields 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-dirtyfields', u'django-dirtyfields Documentation',
+ author, 'django-dirtyfields', '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
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 0000000..63e8e19
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,9 @@
+Contributing
+============
+If you're interested in developing it, you can launch project tests on that way:
+
+::
+
+ $ pip install tox
... 1449 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/django-dirtyfields.git
More information about the Python-modules-commits
mailing list