Merge pull request #22 from Pylons/annual-housecleaning

Annual housecleaning

.travis.yml

@@ -12,6 +12,16 @@ matrix:
           env: TOXENV=py35
         - python: 3.6
           env: TOXENV=py36
+        - python: 3.7
+          env: TOXENV=py37
+          dist: xenial
+          sudo: true
+        - python: 3.8-dev
+          env: TOXENV=py38
+          dist: xenial
+          sudo: true
+    allow_failures:
+        - env: TOXENV=py38
 
 
 install:

CHANGES.rst

-Changelog
-=========
+.. _change-log:
+
+Change Log
+----------
 
 2.3.1 (unreleased)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 - TBD
 
 2.3.0 (2017-10-17)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 - Fix parsing of ``zeo://`` URI with IPv6 address.
 
@@ -16,18 +18,18 @@ Changelog
 - Add support for Python 3.6.
 
 2.2.2 (2017-05-05)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 - Fix transposed ``install_requires`` and ``tests_require`` lists in
   ``setup.py``.
 
 2.2.1 (2017-04-18)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 - Fix breakage added in 2.2 to the ``zconfig`` resolver.
 
 2.2 (2017-04-17)
-----------------
+~~~~~~~~~~~~~~~~
 
 - Add support for additional database configuration parameters:
   ``pool_timeout``, ``cache_size_bytes``, ``historical_pool_size``,
@@ -35,7 +37,7 @@ Changelog
   ``historical_timeout``, and ``large_record_size``.
 
 2.1 (2017-04-17)
-----------------
+~~~~~~~~~~~~~~~~
 
 - Add support for Python 3.4 and 3.5.
 
@@ -44,7 +46,7 @@ Changelog
 - Add missing ClientStorage constructor kw args to resolver.
 
 2.0 (2014-01-05)
-----------------
+~~~~~~~~~~~~~~~~
 
 - Update ``ZODB3`` meta-package dependency to ``ZODB`` + ``ZConfig`` + ``ZEO``.
   Those releases are what we import, and have final Py3k-compatible releases.
@@ -52,7 +54,7 @@ Changelog
 - Packaging:  fix missing ``url`` argument to ``setup()``.
 
 2.0b1 (2013-05-02)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 - Add support for Python 3.2 / 3.3.
 
@@ -71,13 +73,13 @@ Changelog
 - Drop support for Python 2.5.
 
 1.1 (2012-09-12)
-----------------
+~~~~~~~~~~~~~~~~
 
 - Remove support for ``postgres://`` URIs, which will now be provided by
   the ``relstorage`` package.  Thanks to Georges Dubus for the patch!
 
 1.0 (2012-06-07)
-----------------
+~~~~~~~~~~~~~~~~
 
 - Add support for ``postgres://`` URIs.  Thanks to Georges Dubus for
   the patch!
@@ -86,9 +88,9 @@ Changelog
   tox under Python 2.5.
 
 - Update the documentation for publication to `ReadTheDocs
-  <http://docs.pylonsproject.org/projects/zodburi/dev/>`_
+  <https://docs.pylonsproject.org/projects/zodburi/en/latest/>`_
 
 1.0b1 (2011-08-21)
-------------------
+~~~~~~~~~~~~~~~~~~
 
 - Initial release.

COPYRIGHT.txt

 Copyright (c) 2008-2011 Agendaless Consulting and Contributors.
-(http://www.agendaless.com), All Rights Reserved
+(https://agendaless.com/), All Rights Reserved

README.rst

@@ -5,5 +5,5 @@ A library which parses URIs and converts them to ZODB storage objects and
 database arguments.
 
 See the documentation at
-http://docs.pylonsproject.org/projects/zodburi/en/latest/ for more information.
+https://docs.pylonsproject.org/projects/zodburi/en/latest/ for more information.
 

contributing.md

+# Contributing
+
+All projects under the Pylons Project, including this one, follow the guidelines established at [How to Contribute](https://pylonsproject.org/community-how-to-contribute.html), [Coding Style and Standards](https://pylonsproject.org/community-coding-style-standards.html), and [Pylons Project Documentation Style Guide](https://docs.pylonsproject.org/projects/zodburi/).
+
+You can contribute to this project in several ways.
+
+*   [File an Issue on GitHub](https://github.com/Pylons/zodburi/issues)
+*   Fork this project, create a new branch, commit your suggested change, and push to your fork on GitHub.
+    When ready, submit a pull request for consideration.
+    [GitHub Flow](https://guides.github.com/introduction/flow/index.html) describes the workflow process and why it's a good practice.
+    When submitting a pull request, sign [CONTRIBUTORS.txt](https://github.com/Pylons/zodburi/blob/master/CONTRIBUTORS.txt) if you have not yet done so.
+*   Join the [IRC channel #pyramid on irc.freenode.net](https://webchat.freenode.net/?channels=pyramid).
+
+## Git Branches
+
+Git branches and their purpose and status at the time of this writing are listed below.
+
+*   [master](https://github.com/Pylons/zodburi/) - The branch which should always be *deployable*. The default branch on GitHub.
+*   For development, create a new branch. If changes on your new branch are accepted, they will be merged into the master branch and deployed.
+
+## Prerequisites
+
+Follow the instructions in [README.rst](https://github.com/Pylons/zodburi/) to install the tools needed to run the project.

docs/conf.py

@@ -17,11 +17,14 @@
 # make it absolute, like shown here.
 #sys.path.append(os.path.abspath('some/directory'))
 
-import sys, os
+import datetime
+import pkg_resources
 import pylons_sphinx_themes
 
 # General configuration
 # ---------------------
+thisyear = datetime.datetime.now().year
+copyright = '2011-%s, Agendaless Consulting <chrism@plope.com>' % thisyear
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -41,13 +44,12 @@ master_doc = 'index'
 
 # General substitutions.
 project = 'zodburi'
-copyright = '2011, 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.0'
+version = pkg_resources.get_distribution('zodburi').version
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -86,12 +88,11 @@ pygments_style = 'sphinx'
 # -----------------------
 
 # Add and use Pylons theme
-sys.path.append(os.path.abspath('_themes'))
 html_theme_path = pylons_sphinx_themes.get_html_themes_path()
 html_theme = 'pylons'
 html_theme_options = dict(
-    github_url='http://github.com/Pylons/zodburi',
-    canonical_url='http://docs.pylonsproject.org/projects/zodburi/en/latest/',
+    github_url='https://github.com/Pylons/zodburi',
+    canonical_url='https://docs.pylonsproject.org/projects/zodburi/en/latest/',
 )
 
 # The style sheet to use for HTML and HTML Help pages. A file of that name
@@ -126,12 +127,19 @@ html_theme_options = dict(
 # bottom, using the given strftime format.
 html_last_updated_fmt = '%b %d, %Y'
 
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
+# Do not use smart quotes.
+smartquotes = False
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
+# Control display of sidebars and include ethical ads from RTD
+html_sidebars = {'**': [
+    'localtoc.html',
+    'ethicalads.html',
+    'relations.html',
+    'sourcelink.html',
+    'searchbox.html',
+]}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

docs/index.rst

@@ -50,7 +50,7 @@ are ``file://``, ``zeo://``, ``zconfig://``, ``memory://``
 In addition to those schemes, the relstorage_ package adds support for
 ``postgres://``.
 
-.. _relstorage : http://pypi.python.org/pypi/RelStorage
+.. _relstorage : https://pypi.org/project/RelStorage/
 
 ``file://`` URI scheme
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -368,10 +368,14 @@ More Information
 Reporting Bugs / Development Versions
 -------------------------------------
 
-Visit http://github.com/Pylons/zodburi to download development or
+Visit https://github.com/Pylons/zodburi to download development or
 tagged versions.
 
-Visit http://github.com/Pylons/zodburi/issues to report bugs.
+Visit https://github.com/Pylons/zodburi/issues to report bugs.
+
+
+.. include:: ../CHANGES.rst
+
 
 Indices and tables
 ------------------

setup.py

@@ -21,9 +21,9 @@ requires = ['ZODB', 'ZConfig', 'ZEO']
 tests_require = requires + ['mock']
 testing_extras = tests_require + ['nose', 'coverage']
 docs_extras = tests_require + [
-    'Sphinx >= 1.3.1',
+    'Sphinx >= 1.8.1',
     'repoze.sphinx.autointerface',
-    'pylons-sphinx-themes',
+    'pylons-sphinx-themes >= 1.0.10',
 ]
 
 setup(name='zodburi',
@@ -39,12 +39,13 @@ setup(name='zodburi',
         "Programming Language :: Python :: 3.4",
         "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
         "License :: Repoze Public License",
         ],
       keywords='zodb zodbconn',
       author="Chris Rossi",
       author_email="pylons-discuss@googlegroups.com",
-      url="http://pylonsproject.org",
+      url="https://pylonsproject.org/",
       license="BSD-derived (http://www.repoze.org/LICENSE.txt)",
       packages=find_packages(),
       include_package_data=True,

tox.ini

 [tox]
 envlist =
-    py27,py34,py35,py36,cover,docs
+    py27,py34,py35,py36,py37,cover,docs
 
 [testenv]
 commands =