docs: Fix simple typo, idential -> identical

.coveragerc

@@ -0,0 +1,8 @@
+[run]
+source = picklefield
+branch = True
+
+[report]
+exclude_lines =
+    pragma: no cover
+    except ImportError:

.gitignore

@@ -1,7 +1,7 @@
-*.pyc
-*.pyo
-/build
-/dist
-/temp
-/src/django_picklefield.egg-info
-
+syntax:glob
+*.py[co]
+dist/
+django_picklefield.egg-info/*
+build/
+.coverage
+.tox

.travis.yml

@@ -0,0 +1,35 @@
+dist: bionic
+sudo: false
+language: python
+cache: pip
+python:
+  - 2.7
+  - 3.5
+  - 3.6
+  - 3.7
+  - 3.8
+stages:
+  - lint
+  - test
+jobs:
+  fast_finish: true
+  include:
+    - { stage: lint, env: TOXENV=flake8, python: 3.6 }
+    - { stage: lint, env: TOXENV=isort, python: 3.6 }
+
+install:
+- pip install tox coveralls tox-travis
+script:
+- tox
+after_success:
+- if [ -f .coverage ]; then coveralls; fi
+before_deploy: "pip install django"
+deploy:
+  provider: pypi
+  user: charettes
+  password:
+    secure: Ix/iLGKu+usjaNGPIKRzvgdZz8TVxReiMFLorgMpHb9P29tgIBQSDzVmo8gzUi+LF4SQs2AdnuYJY15ap68JX7iLfCuWWYIvIqgMLb3W64jfUDg9KpLJQYCv6cTKQHoDVtVTg0jXJmauEYMMYuqmdrSgZ6rSfpsbajMrveCzVuStb7kd5H4WPX3/j4JfCmr07CyAi85rLAnaIfmCYADWC4nrYll7+0Ugke64C4KstY0l6HYBNTT5ZwJvXSNd0VQd31b5okv8bwjGXzeVrbgIAe+c1p0lS11hsNqfLL/rrnlvgC7P7568TxGwWVmIDJm131r1K7skLscEfCuPbJJ3oqljxLQMQIJ4JbR12HtRwB93dOnJOgCbqySAJAZHUvkm2r3VAO8BJK3xYnJg/2IGrxolDQxwJi2SMEgwqQZx3thTFKXvviiWn5dnLjiNRpSOHUzayCVYga7WAgVksKVMbmtcNrJWwrAHtWLxo9vnM2W+6JNFeXiGIIwGu7qJ/Sz/qCuv/uKibbFqhUJfATXf5HhSJ3yIM/Ef04/SSpBqkYcFcrGLdzzW2Bpv4jscv4EcNyGDxnzeJtvXWVceoW0g7XweUn4b5P+NvOSV4YCjJ04BU4r/upV7+ulkQxnCWot2MD0zhvlodldn+6tGfdBbYJ/KlBHQjwdjFFKaxqRkuyA=
+  distributions: sdist bdist_wheel
+  on:
+    tags: true
+    condition: "$TRAVIS_PYTHON_VERSION = 2.7"

LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2009-2010 Gintautas Miliauskas
+Copyright (c) 2011-2018 Simon Charette
 
  Permission is hereby granted, free of charge, to any person
  obtaining a copy of this software and associated documentation

MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.rst

README → README.rst

@@ -1,17 +1,44 @@
+django-picklefield
+==================
+
+.. image:: https://img.shields.io/pypi/l/django-picklefield.svg?style=flat
+    :target: https://pypi.python.org/pypi/django-picklefield/
+    :alt: License
+
+.. image:: https://img.shields.io/pypi/v/django-picklefield.svg?style=flat
+    :target: https://pypi.python.org/pypi/django-picklefield/
+    :alt: Latest Version
+
+.. image:: https://travis-ci.org/gintas/django-picklefield.svg?branch=master
+    :target: https://travis-ci.org/gintas/django-picklefield
+    :alt: Build Status
+
+.. image:: https://coveralls.io/repos/gintas/django-picklefield/badge.svg?branch=master
+    :target: https://coveralls.io/r/gintas/django-picklefield?branch=master
+    :alt: Coverage Status
+
+.. image:: https://img.shields.io/pypi/pyversions/django-picklefield.svg?style=flat
+    :target: https://pypi.python.org/pypi/django-picklefield/
+    :alt: Supported Python Versions
+
+.. image:: https://img.shields.io/pypi/wheel/django-picklefield.svg?style=flat
+    :target: https://pypi.python.org/pypi/django-picklefield/
+    :alt: Wheel Status
+
 -----
 About
 -----
 
 **django-picklefield** provides an implementation of a pickled object field.
 Such fields can contain any picklable objects.
 
-The implementation is taken and adopted from Django snippet #1694
-<http://www.djangosnippets.org/snippets/1694/> by Taavi Taijala, which is in
-turn based on Django snippet #513 <http://www.djangosnippets.org/snippets/513/>
-by Oliver Beattie.
+The implementation is taken and adopted from `Django snippet #1694`_ by Taavi
+Taijala, which is in turn based on `Django snippet #513`_  by Oliver Beattie.
 
 django-picklefield is available under the MIT license.
 
+.. _Django snippet #1694: http://www.djangosnippets.org/snippets/1694/
+.. _Django snippet #513: http://www.djangosnippets.org/snippets/513/
 
 -----
 Usage
@@ -20,13 +47,17 @@ Usage
 First of all, you need to have **django-picklefield** installed; for your
 convenience, recent versions should be available from PyPI.
 
-To use, just define a field in your model::
+To use, just define a field in your model:
+
+.. code:: python
 
     >>> from picklefield.fields import PickledObjectField
     ... class SomeObject(models.Model):
     ...     args = PickledObjectField()
 
-and assign whatever you like (as long as it's picklable) to the field::
+and assign whatever you like (as long as it's picklable) to the field:
+
+.. code:: python
 
     >>> obj = SomeObject()
     >>> obj.args = ['fancy', {'objects': 'inside'}]
@@ -44,6 +75,23 @@ base64-encoded pickles, which allows reliable deserialization, but such a
 format is not convenient for parsing in the browser.  By overriding
 ``value_to_string()`` you can choose a more convenient serialization format.
 
+Fields now accept the boolean key word argument `copy`, which defaults to
+`True`. The `copy` is necessary for lookups to work correctly. If you don't
+care about performing lookups on the picklefield, you can set `copy=False` to
+save on some memory usage. This an be especially beneficial for very large
+object trees.
+
+-------------
+Running tests
+-------------
+
+The full test suite can be run with `Tox`_::
+
+    >>> pip install tox
+    >>> tox
+
+.. _Tox: https://testrun.org/tox/latest/
+
 --------------
 Original notes
 --------------
@@ -114,55 +162,117 @@ since it is never a good idea to have a PickledObjectField be user editable.
 Changes
 -------
 
+Changes in version 2.1.0
+========================
+
+* Added official support for Django 2.2 (thanks to joehybird).
+* Dropped support for Django 2.0 and 2.1 (thanks to joehybird).
+* Dropped support for Python 3.4 (thanks to joehybidd).
+
+Changes in version 2.0.0
+========================
+
+* Silenced ``RemovedInDjango30Warning`` warnings on Django 2.0+ (thanks to
+  canarduck).
+* Restructured project directories.
+* Disallowed the usage of empty strings for ``PickledObjectField``. That makes
+  ``.save()``, ``.create()``, etc. raise ``IntegrityError`` if `null` is not
+  ``True`` and no default value was specified like built-in fields do
+  (thanks to Attila-Mihaly Balazs).
+* Added a check for mutable default values to ``PickledObjectField``.
+
+Changes in version 1.1.0
+========================
+
+* Added support for Django 2.1 and dropped support for Django < 1.11.
+
+Changes in version 1.0.0
+========================
+
+* Added a new option to prevent a copy of the object before pickling: `copy=True`
+* Dropped support for Django 1.4
+* Dropped support for Django 1.7
+* Dropped support for Python 3.2
+* Added support for Python 3.6
+
+Changes in version 0.3.2
+========================
+
+* Dropped support for Django 1.3.
+* Dropped support for Python 2.5.
+* Silenced deprecation warnings on Django 1.8+.
+
+Changes in version 0.3.1
+========================
+
+* Favor the built in json module (thanks to Simon Charette).
+
+Changes in version 0.3.0
+========================
+
+* Python 3 support (thanks to Rafal Stozek).
+
+Changes in version 0.2.0
+========================
+
+* Allow pickling of subclasses of django.db.models.Model (thanks to Simon
+  Charette).
+
+Changes in version 0.1.9
+========================
+
+* Added `connection` and `prepared` parameters to `get_db_prep_value()` too
+  (thanks to Matthew Schinckel).
+
 Changes in version 0.1.8
 ========================
 
- * Updated link to code repository.
+* Updated link to code repository.
 
 Changes in version 0.1.7
 ========================
 
- * Added `connection` and `prepared` parameters to `get_db_prep_lookup()` to
-   get rid of deprecation warnings in Django 1.2.
+* Added `connection` and `prepared` parameters to `get_db_prep_lookup()` to
+  get rid of deprecation warnings in Django 1.2.
 
 Changes in version 0.1.6
 ========================
 
- * Fixed South support (thanks aehlke@github).
+* Fixed South support (thanks aehlke@github).
 
 Changes in version 0.1.5
 ========================
 
- * Added support for South.
- * Changed default to null=False, as is common throughout Django.
+* Added support for South.
+* Changed default to null=False, as is common throughout Django.
 
 Changes in version 0.1.4
 ========================
 
- * Updated copyright statements.
+* Updated copyright statements.
 
 Changes in version 0.1.3
 ========================
 
- * Updated serialization tests (thanks to Michael Fladischer).
+* Updated serialization tests (thanks to Michael Fladischer).
 
 Changes in version 0.1.2
 ========================
 
- * Added Simplified BSD licence.
+* Added Simplified BSD licence.
 
 Changes in version 0.1.1
 ========================
 
- * Added test for serialization.
- * Added note about JSON serialization for browser.
- * Added support for different pickle protocol versions (thanks to Michael
-   Fladischer).
+* Added test for serialization.
+* Added note about JSON serialization for browser.
+* Added support for different pickle protocol versions (thanks to Michael
+  Fladischer).
 
 Changes in version 0.1
 ======================
 
- * First public release.
+* First public release.
 
 
 --------

picklefield/__init__.py

@@ -0,0 +1,12 @@
+from __future__ import unicode_literals
+
+import django.utils.version
+
+from .constants import DEFAULT_PROTOCOL
+from .fields import PickledObjectField
+
+__all__ = 'VERSION', '__version__', 'DEFAULT_PROTOCOL', 'PickledObjectField'
+
+VERSION = (2, 1, 1, 'final', 0)
+
+__version__ = django.utils.version.get_version(VERSION)

picklefield/constants.py

@@ -0,0 +1,3 @@
+from __future__ import unicode_literals
+
+DEFAULT_PROTOCOL = 2