* update docs pyramid_ldap to version 0.2

* add changlog to the docs
* remove python 2.6 as supported python from tox
* add basic installation instructions to the README.rst

.gitignore

@@ -4,6 +4,8 @@
 *.pyc
 *$py.class
 *~
+/.eggs
+
 .coverage
 .tox/
 nosetests.xml

README.rst

@@ -1,5 +1,6 @@
-``pyramid_ldap``
-================
+############
+Pyramid LDAP
+############
 
 ``pyramid_ldap`` provides LDAP authentication services for your Pyramid
 application.  Thanks to the ever-awesome `SurveyMonkey
@@ -11,3 +12,12 @@ information.
 
 This package will only work with Pyramid 1.3a9 and better.
 
+Installation
+------------
+
+``pyramid_ldap`` uses pyldap which in turn requires ``libldap2`` and
+``libsasl2`` development headers installed
+
+On Ubuntu 16.04 you can install them using
+``apt-get install libldap2-dev libsasl2-dev`` command.
+

RELEASING.txt

@@ -0,0 +1,112 @@
+Distributing a new release
+==========================
+
+- For clarity, we define releases as follows.
+
+  - Alpha, beta, dev and similar statuses do not qualify whether a release is
+    major or minor. The term "pre-release" means alpha, beta, or dev.
+
+  - A release is final when it is no longer pre-release.
+
+  - A *major* release is where the first number either before or after the
+    first dot increases. Examples: 0.9.0 to 2.0.
+
+  - A *minor* or *bug fix* release is where the number after the second dot
+    increases. Example: 2.0 to 2.0.1.
+
+Prepare new release branch
+--------------------------
+
+- On master branch:
+
+  $ git pull
+
+- Do platform test via tox:
+
+- Make sure your Python has ``setuptools-git``, ``twine``, and ``wheel``
+  installed:
+
+    $ $VENV/bin/pip install setuptools-git twine wheel
+
+- Do a platform test:
+
+    $ tox -r
+
+- Ensure all features of the release are documented (audit CHANGES.txt or
+  communicate with contributors).
+
+- Change CHANGES.txt heading to reflect the new version number.
+
+- Update README.rst to use correct versions of badges and URLs according to
+  each branch and context, i.e., RTD "latest" == GitHub/Travis "2.0-branch".
+
+- For major version releases, in docs/conf.py, update values for version.
+
+- Change setup.py version to the release version number.
+
+- Make sure PyPI long description renders (requires ``collective.dist``
+  installed into your Python)::
+
+    $ $VENV/bin/python setup.py check -r
+
+- Build an sdist and a wheel:
+
+    $ $VENV/bin/python setup.py sdist bdist_wheel
+
+- Release the wheels to PyPI:
+
+    $ $VENV/bin/twine upload dist/pyramid_ldap-X.Y*
+
+- Upload a git tag for the release:
+
+    $ git tag X.Y
+    $ git push origin X.Y
+
+- Update RTD to render a new version of the docs at that tag X.Y and set X.Y
+  as the default branch such that /latest/ points to it.
+
+- Publish new version of docs.
+
+- Announce to Twitter.
+
+```
+pyramid_ldap X.Y released.
+
+PyPI
+https://pypi.python.org/pypi/pyramid_ldap/
+
+=== One time only for new version, first pre-release ===
+What's New
+http://docs.pylonsproject.org/projects/pyramid_ldap/latest/
+=== For all subsequent pre-releases ===
+Changes
+http://docs.pylonsproject.org/projects/pyramid_ldap/latest/changes.html#version-yyyy-mm-dd
+
+Issues
+https://github.com/Pylons/pyramid_ldap/issues
+```
+
+- Announce to Pyramid maillist.
+
+```
+pyramid_ldap X.Y has been released.
+
+Here are the changes:
+
+<<changes>>
+
+Links
+
+- Documentation http://docs.pylonsproject.org/projects/pyramid_ldap/latest/#changelog
+
+- Github https://github.com/pylons/pyramid_ldap/
+
+- PyPi https://pypi.python.org/pypi/pyramid_ldap/
+
+Enjoy, and please report any issues you find to the issue tracker at
+https://github.com/Pylons/pyramid_ldap/issues
+
+Thanks!
+
+- pyramid_ldap developers
+```

docs/conf.py

@@ -59,13 +59,13 @@
 
 # General substitutions.
 project = 'pyramid_ldap'
-copyright = '2012, Agendaless Consulting <chrism@plope.com>'
+copyright = '2017, Agendaless Consulting <chrism@plope.com>'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.2'
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/index.rst

@@ -10,14 +10,21 @@ application.  Thanks to the ever-awesome `SurveyMonkey
 
 .. warning:: This package only works with Pyramid 1.3a9 and better.
 
+Changelog
+---------
+
+.. include:: ../CHANGES.txt
+
 Installation
 ------------
 
 ``pyramid_ldap`` depends on the `python-ldap <http://www.python-ldap.org/>`_
 and `ldappool <https://github.com/mozilla-services/ldappool>`_ packages.
 ``python_ldap`` requires OpenLDAP development libraries to be installed
 before it can successfully be installed.  An easy way to get these installed
-on a Debian Linux system is to use ``apt-get build-dep python-ldap``.
+on a Debian Linux system is to use ``apt-get build-dep python-ldap``. Or in
+Ubuntu 16.04 ``apt-get install libldap2-dev libsasl2-dev``
+
 
 After you've got the OpenLDAP dependencies installed, you can install
 ``pyramid_ldap`` using setuptools, e.g. (within a virtualenv)::
@@ -175,7 +182,7 @@ Here's a small application which uses the ``pyramid_ldap`` API:
                 return HTTPFound('/', headers=headers)
             else:
                 error = 'Invalid credentials'
-                
+
         return dict(
             login_url=url,
             login=login,
@@ -332,6 +339,7 @@ tagged versions.
 
 Visit http://github.com/Pylons/pyramid_ldap/issues to report bugs.
 
+
 Indices and tables
 ------------------
 

tox.ini

@@ -1,18 +1,17 @@
 [tox]
-envlist = 
-    py26,py27,cover
+envlist =
+    py27,cover
 
 [testenv]
-commands = 
+commands =
     python setup.py test -q
 
 [testenv:cover]
 basepython =
-    python2.6
-commands = 
+    python2.7
+commands =
     python setup.py nosetests --with-xunit --with-xcoverage
 deps =
     nose
     coverage
     nosexcover
-