Bumped linters. Moved version linting to setup.py.

Bumped linter versions and moved version consistency checks into a
setup.py command.

Pinning dependency versions in tox.ini.

Author: Robpol86

setup.py

@@ -5,20 +5,26 @@
 
 import codecs
 import os
+import re
 
-from setuptools import setup
+from setuptools import Command, setup
 
+IMPORT = 'sphinxcontrib.versioning'
+INSTALL_REQUIRES = ['colorclass', 'docopt', 'sphinx']
+LICENSE = 'MIT'
 NAME = 'sphinxcontrib-versioning'
 VERSION = '1.0.0'
 
 
-def readme():
+def readme(path='README.rst'):
     """Try to read README.rst or return empty string if failed.
 
+    :param str path: Path to README file.
+
     :return: File contents.
     :rtype: str
     """
-    path = os.path.realpath(os.path.join(os.path.dirname(__file__), 'README.rst'))
+    path = os.path.realpath(os.path.join(os.path.dirname(__file__), path))
     handle = None
     url_prefix = 'https://raw.githubusercontent.com/Robpol86/{name}/v{version}/'.format(name=NAME, version=VERSION)
     try:
@@ -30,6 +36,42 @@ def readme():
         getattr(handle, 'close', lambda: None)()
 
 
+class CheckVersion(Command):
+    """Make sure version strings and other metadata match here, in module/package, tox, and other places."""
+
+    description = 'verify consistent version/etc strings in project'
+    user_options = []
+
+    @classmethod
+    def initialize_options(cls):
+        """Required by distutils."""
+        pass
+
+    @classmethod
+    def finalize_options(cls):
+        """Required by distutils."""
+        pass
+
+    @classmethod
+    def run(cls):
+        """Check variables."""
+        project = __import__(IMPORT, fromlist=[''])
+        for expected, var in [('@Robpol86', '__author__'), (LICENSE, '__license__'), (VERSION, '__version__')]:
+            if getattr(project, var) != expected:
+                raise SystemExit('Mismatch: {0}'.format(var))
+        # Check changelog.
+        if not re.compile(r'^%s - \d{4}-\d{2}-\d{2}$' % VERSION, re.MULTILINE).search(readme()):
+            raise SystemExit('Version not found in readme/changelog file.')
+        # Check tox.
+        if INSTALL_REQUIRES:
+            section = re.compile(r'\ninstall_requires =\n(.+?)\n\w', re.DOTALL).findall(readme('tox.ini'))
+            if not section:
+                raise SystemExit('Missing install_requires section in tox.ini.')
+            in_tox = re.findall(r'    ([^=]+)==[\w\d.-]+', section[0])
+            if INSTALL_REQUIRES != in_tox:
+                raise SystemExit('Missing/unordered pinned dependencies in tox.ini.')
+
+
 setup(
     author='@Robpol86',
     author_email='[email protected]',
@@ -50,15 +92,16 @@ def readme():
         'Topic :: Documentation :: Sphinx',
         'Topic :: Software Development :: Documentation',
     ],
+    cmdclass=dict(check_version=CheckVersion),
     description='Sphinx extension that allows building versioned docs for self-hosting.',
     entry_points={'console_scripts': ['sphinx-versioning = sphinxcontrib.versioning.__main__:entry_point']},
-    install_requires=['colorclass', 'docopt', 'sphinx'],
+    install_requires=INSTALL_REQUIRES,
     keywords='sphinx versioning versions version branches tags',
-    license='MIT',
+    license=LICENSE,
     long_description=readme(),
     name=NAME,
-    package_data={'': ['_templates/versions.html']},
-    packages=[NAME.split('-')[0], os.path.join(*NAME.split('-'))],
+    package_data={'': [os.path.join('_templates', 'versions.html')]},
+    packages=['sphinxcontrib', os.path.join('sphinxcontrib', 'versioning')],
     url='https://github.com/Robpol86/' + NAME,
     version=VERSION,
     zip_safe=True,

tests/test__main__/test_main_push_scenarios.py

@@ -155,7 +155,7 @@ def test_error_clone_failure(local_docs, run):
 
 
 def test_error_build_failure(local_docs_ghp, run):
-    """HandledError in main_build().
+    """Test HandledError in main_build().
 
     :param local_docs_ghp: conftest fixture.
     :param run: conftest fixture.

tox.ini

@@ -1,8 +1,9 @@
 [general]
-author = @Robpol86
-license = MIT
+install_requires =
+    colorclass==2.2.0
+    docopt==0.6.2
+    sphinx==1.4.5
 name = sphinxcontrib
-version = 1.0.0
 
 [tox]
 envlist = lint,py{34,27}
@@ -12,6 +13,7 @@ commands =
     py.test --cov-report term-missing --cov-report xml --cov {[general]name} --cov-config tox.ini \
         {posargs:tests}
 deps =
+    {[general]install_requires}
     pytest-catchlog==1.2.2
     pytest-cov==2.3.0
     sphinx_rtd_theme==0.1.10a0
@@ -24,20 +26,15 @@ commands =
     python setup.py check --strict
     python setup.py check --strict -m
     python setup.py check --strict -s
+    python setup.py check_version
     flake8 --application-import-names={[general]name},tests
     pylint --rcfile=tox.ini setup.py {[general]name}
-    python -c "assert '{[general]author}' == __import__('{[general]name}.versioning').versioning.__author__"
-    python -c "assert '{[general]license}' == __import__('{[general]name}.versioning').versioning.__license__"
-    python -c "assert '{[general]version}' == __import__('{[general]name}.versioning').versioning.__version__"
-    python -c "assert 'author=\'{[general]author}\'' in open('setup.py').read(102400)"
-    python -c "assert 'license=\'{[general]license}\'' in open('setup.py').read(102400)"
-    python -c "assert 'VERSION = \'{[general]version}\'' in open('setup.py').read(102400)"
-    python -c "assert '\n{[general]version} - ' in open('README.rst').read(102400)"
 deps =
-    coverage==4.2b1
-    flake8==2.5.5
-    flake8-import-order==0.5
-    flake8-pep257==1.0.5
+    {[general]install_requires}
+    coverage==4.2
+    flake8==3.0.3
+    flake8-import-order==0.9.1
+    flake8-docstrings==1.0.2
     pep8-naming==0.4.1
     pylint==1.6.4
 
@@ -46,7 +43,7 @@ changedir = {toxinidir}/docs
 commands =
     sphinx-build -a -E -W . _build/html
 deps =
-    Sphinx==1.4.5
+    {[general]install_requires}
     sphinx-rtd-theme==0.1.10a0
 
 [testenv:docsV]
@@ -63,8 +60,7 @@ passenv =
 
 [flake8]
 exclude = .tox/*,build/*,docs/*,env/*,get-pip.py
-ignore = D203
-import-order-style = google
+import-order-style = smarkets
 max-line-length = 120
 statistics = True