Bump version, add changelog.

This release fixes #7 - support non-integer PKs.

Author: sergei-maertens

README.rst

@@ -19,7 +19,7 @@ Prerequisites
 
 This project uses `django.contrib.postgres.JSONField`, and as such, you need:
 
-* at least Django 1.10
+* at least Django 1.11
 * at least PostgreSQL 9.4
 * at least psycopg2 2.5.4
 
@@ -31,7 +31,7 @@ Install from PyPI by running
 
     pip install django-timeline-logger
 
-Add `'timeline_logger'` to your `INSTALLED_APPS`.
+Add ``'timeline_logger'`` to your ``INSTALLED_APPS``.
 
 Run the migrations:
 
@@ -65,4 +65,4 @@ Documentation
 
 The extended documentation is available on `Read the Docs`_.
 
-.. _`Read the Docs`: http://django-timeline-logger.readthedocs.io/en/latest/
+.. _Read the Docs: http://django-timeline-logger.readthedocs.io/en/latest/

docs/changelog.rst

@@ -0,0 +1,37 @@
+=========
+Changelog
+=========
+
+1.0 (2018-03-15)
+================
+
+Breaking changes
+----------------
+
+* Changed the GFK object_id field to a text field, so that non-integer primary
+  keys are supported. This may come at a (small) performance hit. Depending
+  on the data you're storing, the backwards migration may break.
+
+* Dropped Django 1.10 support, per Django's version support policy. If you're
+  still on Django 1.10, you should upgrade, but other than that the app
+  probably still works.
+
+New features
+------------
+
+* You can now create log entries without referring to a specific object
+  (thanks @tsiaGeorge).
+
+* Support non-integer PKs for objects (see #7, thanks for the feedback @holms)
+
+Other
+-----
+
+* first pass at better supporting internationalization
+
+* cleaned up package a bit, added isort etc.
+
+Pre 1.0
+=======
+
+Best guess is looking at the git log, sorry.

docs/conf.py

@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.8'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.8.0'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -36,7 +36,7 @@ Requirements
 Django Timeline Logger makes use of Django's ``contrib.postgres.JSONField``,
 then your backend will need:
 
-   - At least Django-1.10_.
+   - At least Django-1.11_.
    - At least PostgreSQL-9.4_.
    - At least psycopg2-2.5.4_.
 
@@ -52,6 +52,7 @@ Contents
    sending_log_reports
    settings
    contributing
+   changelog
 
 
 License
@@ -77,7 +78,7 @@ Indices and tables
 * :ref:`search`
 
 
-.. _Django-1.10: https://docs.djangoproject.com/en/1.10/releases/1.10/
+.. _Django-1.11: https://docs.djangoproject.com/en/1.11/releases/1.11/
 .. _PostgreSQL-9.4: https://www.postgresql.org/docs/9.4/static/release-9-4.html
 .. _psycopg2-2.5.4: https://pypi.python.org/pypi/psycopg2/2.5.4
 .. _MIT License: https://opensource.org/licenses/MIT

setup.py

@@ -14,14 +14,14 @@
 
 setup(
     name='django-timeline-logger',
-    version='0.8.0',
+    version='1.0',
     description='Generic event logger for Django models.',
     long_description=long_description,
     author='Maykin Media',
     author_email='[email protected]',
     url='https://github.com/maykinmedia/django-timeline-logger',
     install_requires=[
-        'Django>=1.10',
+        'Django>=1.11',
         'django-appconf',
     ],
     packages=find_packages(exclude=['tests*']),
@@ -41,7 +41,6 @@
     ],
     classifiers=[
         'Development Status :: 5 - Production/Stable',
-        'Framework :: Django :: 1.10',
         'Framework :: Django :: 1.11',
         'Framework :: Django :: 2.0',
         'Intended Audience :: Developers',