Check-in new revision
=====================

* update CHANGELOG if necessary
* run the test suite
  $ run.py --test [--clean]
* run the doctests
  $ run.py --doctest


Release a new version
=====================

Tests
-----

* run the test suite 
  $ run.py --test [--clean]
* make sure the tests pass for all supported Python versions, e.g.
  $ python3.4 run.py --test --clean
* there is also a bash script to test Pympler on multiple Python versions
  $ bash tools/release_test.sh
* check test coverage with coverage.py (http://nedbatchelder.com/code/coverage/)
  $ coverage run test/runtest.py
  $ coverage html

Docs
----

* check that the documentation builds
  $ run.py --html --verbose=1
* check if doctests pass
  $ run.py --doctest --verbose=1
* check links
  $ run.py --linkcheck --verbose=1
* build the documentation
  $ run.py --html --keep
  
Checks
------
  
* check the meta data specified in pympler/metadata.py
* check the CHANGELOG file for missing entries
* check the NOTICE file for missing contributors
* check the to-be-released module distributions
  $ run.py --dist [--html --keep]

Release
-------
  
* clean the working copy from any local changes
* build the source distribution
  $ python setup.py sdist
* test installing the build in a new virtual env
  $ pip install dist/Pympler-X.X.tar.gz
* release a new version to the Python package index
  $ twine upload dist/Pympler-X.X.tar.gz
* check the documentation at https://pympler.readthedocs.io/en/latest/
