Initial commit

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Grant McConnaughey <grantmcconnaughey@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

CONTRIBUTING.rst

@@ -0,0 +1,112 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given. 
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/grantmcconnaughey/django-field-history/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+django-field-history could always use more documentation, whether as part of the 
+official django-field-history docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/grantmcconnaughey/django-field-history/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `django-field-history` for local development.
+
+1. Fork the `django-field-history` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/django-field-history.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv django-field-history
+    $ cd django-field-history/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+tests, including testing other Python versions with tox::
+
+    $ flake8 field_history tests
+    $ python setup.py test
+    $ tox
+
+To get flake8 and tox, just pip install them into your virtualenv. 
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check 
+   https://travis-ci.org/grantmcconnaughey/django-field-history/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+    $ python -m unittest tests.test_field_history

HISTORY.rst

@@ -0,0 +1,9 @@
+.. :changelog:
+
+History
+-------
+
+0.1.0 (2016-02-01)
+++++++++++++++++++
+
+* First release on PyPI.

LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2016, Grant McConnaughey
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* 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.
+
+* Neither the name of django-field-history 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 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,6 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+recursive-include field_history *.html *.png *.gif *js *.css *jpg *jpeg *svg *py

Makefile

@@ -0,0 +1,55 @@
+.PHONY: clean-pyc clean-build docs
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "test-all - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+lint:
+	flake8 field_history tests
+
+test:
+	python runtests.py tests
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source field_history runtests.py tests
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+docs:
+	rm -f docs/django-field-history.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ field_history
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	open docs/_build/html/index.html
+
+release: clean
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+sdist: clean
+	python setup.py sdist
+	ls -l dist

README.rst

@@ -0,0 +1,92 @@
+=============================
+django-field-history
+=============================
+
+.. image:: https://badge.fury.io/py/django-field-history.png
+    :target: https://badge.fury.io/py/django-field-history
+
+.. image:: https://travis-ci.org/grantmcconnaughey/django-field-history.png?branch=master
+    :target: https://travis-ci.org/grantmcconnaughey/django-field-history
+
+A Django app to track changes to a model field.
+
+Documentation
+-------------
+
+The full documentation is at https://django-field-history.readthedocs.org.
+
+Quickstart
+----------
+
+Install django-field-history::
+
+    pip install django-field-history
+
+Then use it in a project::
+
+    import field_history
+
+    class Person(models.Model):
+        name = models.CharField(max_length=255)
+
+        history_fields = field_history.FieldHistoryTracker(['name'])
+
+    # No FieldHistory objects yet
+    self.assertEqual(FieldHistory.objects.count(), 0)
+
+    person = Person.objects.create(name='Initial Name')
+
+    # Creating an object will make one
+    self.assertEqual(FieldHistory.objects.count(), 1)
+
+    # This object has some fields on it
+    history = FieldHistory.objects.get()
+    self.assertEqual(history.model_object, person)
+    self.assertEqual(history.field_name, 'name')
+    self.assertEqual(history.field_value, 'Initial Name')
+    self.assertIsNotNone(history.history_date)
+
+    # Updating that particular field creates a new FieldHistory
+    person.name = 'Updated Name'
+    person.save()
+    self.assertEqual(FieldHistory.objects.count(), 2)
+
+    # You can query FieldHistory objects this way
+    histories = FieldHistory.objects.get_for_model_and_field(person, 'name')
+    self.assertQuerysetEqual(person.history_fields.all(), histories)
+
+    # Or using the {field_name}_history property added to your model
+    self.assertQuerysetEqual(person.name_history, histories)
+
+    updated_history = histories.order_by('-history_date').first()
+    self.assertEqual(history.model_object, person)
+    self.assertEqual(history.field_name, 'name')
+    self.assertEqual(history.field_value, 'Updated Name')
+    self.assertIsNotNone(history.history_date)
+
+Features
+--------
+
+* TODO
+
+Running Tests
+--------------
+
+Does the code actually work?
+
+::
+
+    source <YOURVIRTUALENV>/bin/activate
+    (myenv) $ pip install -r requirements-test.txt
+    (myenv) $ python runtests.py
+
+Credits
+---------
+
+Tools used in rendering this package:
+
+*  Cookiecutter_
+*  `cookiecutter-pypackage`_
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage