Modernize packaging.

Author: kdeldycke

.travis.yml

@@ -25,13 +25,25 @@ python:
   # /index-of-release-notes.html#cpython-3-3-compatible-versions
   - pypy3.3-5.2-alpha1
 
-install:
-  - pip install -e .
+before_install:
+  # Check default Python version installed.
+  - python --version
+
+before_script:
   - pip install codecov
 
 script:
-  - coverage run setup.py test
+  # Launch unittests.
+  - pip install -e .[tests]
+  - coverage run ./setup.py test
   - coverage report -m
+  # Check coding style.
+  - pycodestyle
+  # Test that building packages works.
+  - pip install -e .[develop]
+  - ./setup.py sdist bdist_egg bdist_wheel
+  # Validates package metadata.
+  - ./setup.py check -m -r -s
 
 after_script:
   - codecov

CHANGES.rst

@@ -9,9 +9,16 @@ ChangeLog
 * Remove popularity badge: PyPI download counters are broken and no longer
   displayed.
 * Move ``coverage`` config to ``setup.cfg``.
-* Make wheels generated under Python 2 environnment available for Python 3 too.
+* Add ``test`` and ``develop`` dependencies.
+* Only show latest changes in the long description of the package instead of
+  the full changelog.
 * Add default PyLint config.
 * Add default ``pycodestyle`` config.
+* Enforce ``pycodestyle`` checks in Travis CI jobs.
+* Test production of packages in Travis CI jobs.
+* Always check for package metadata in Travis CI jobs.
+* Make wheels generated under Python 2 environnment available for Python 3 too.
+* Add link to full changelog in package's long description.
 
 
 `1.4.1 (2016-10-31) <https://github.com/scaleway/python-scaleway/compare/v1.4.0...v1.4.1>`_

setup.py

@@ -9,67 +9,129 @@
 # file except in compliance with the License. You may obtain a copy of the
 # License at https://opensource.org/licenses/BSD-2-Clause
 
-import os
+from __future__ import (
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals
+)
+
+import io
 import re
 import sys
-from contextlib import closing
+from os import path
 
 from setuptools import find_packages, setup
 
 MODULE_NAME = 'scaleway'
+PACKAGE_NAME = 'scaleway-sdk'
 
-
-def get_version():
-
-    with open(os.path.join(
-        os.path.dirname(__file__), MODULE_NAME, '__init__.py')
-    ) as init:
-
-        for line in init.readlines():
-            res = re.match(r'__version__ *= *[\'"]([0-9\.]*)[\'"]$', line)
-            if res:
-                return res.group(1)
-
-
-def get_long_description():
-    readme = os.path.join(os.path.dirname(__file__), 'README.rst')
-    changes = os.path.join(os.path.dirname(__file__), 'CHANGES.rst')
-    with closing(open(readme)) as hreadme, closing(open(changes)) as hchanges:
-        return hreadme.read() + '\n' + hchanges.read()
-
-
-REQUIREMENTS = [
+DEPENDENCIES = [
     'slumber >= 0.6.2',
     'six']
 
 # Packages required to handle SNI, only for Python2.
 if sys.version_info.major == 2:
-    REQUIREMENTS += [
+    DEPENDENCIES += [
         'pyOpenSSL',
         'ndg-httpsclient',
-        'pyasn1'
-    ]
+        'pyasn1']
+
+EXTRA_DEPENDENCIES = {
+    # Extra dependencies are made available through the
+    # `$ pip install .[keyword]` command.
+    'tests': [
+        'coverage',
+        'httpretty >= 0.8.0',
+        'mock',
+        'nose',
+        'pycodestyle >= 2.1.0',
+        'pylint'],
+    'develop': [
+        'bumpversion',
+        'isort',
+        'readme_renderer',
+        'setuptools >= 24.2.1'
+        'wheel']}
+
+
+def read_file(*relative_path_elements):
+    """ Return content of a file relative to this ``setup.py``. """
+    file_path = path.join(path.dirname(__file__), *relative_path_elements)
+    return io.open(file_path, encoding='utf8').read().strip()
+
+
+# Cache fetched version.
+_version = None  # noqa
+
+
+def version():
+    """ Extract version from the ``__init__.py`` file at the module's root.
+
+    Inspired by: https://packaging.python.org/single_source_version/
+    """
+    global _version
+    if _version:
+        return _version
+    init_file = read_file(MODULE_NAME, '__init__.py')
+    matches = re.search(
+        r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', init_file, re.M)
+    if not matches:
+        raise RuntimeError("Unable to find version string in __init__.py .")
+    _version = matches.group(1)  # noqa
+    return _version
+
+
+def latest_changes():
+    """ Extract part of changelog pertaining to version. """
+    lines = []
+    for line in read_file('CHANGES.rst').splitlines():
+        if line.startswith('-------'):
+            if len(lines) > 1:
+                lines = lines[:-1]
+                break
+        if lines:
+            lines.append(line)
+        elif line.startswith("`{} (".format(version())):
+            lines.append(line)
+    if not lines:
+        raise RuntimeError(
+            "Unable to find changelog for the {} release.".format(version()))
+    # Renormalize and clean lines.
+    return '\n'.join(lines).strip().split('\n')
+
+
+def long_description():
+    """ Collates project README and latest changes. """
+    changes = latest_changes()
+    changes[0] = "`Changes for v{}".format(changes[0][1:])
+    changes[1] = '-' * len(changes[0])
+    return "\n\n\n".join([
+        read_file('README.rst'),
+        '\n'.join(changes),
+        "`Full changelog <https://github.com/scaleway/python-scaleway/blob/"
+        "develop/CHANGES.rst#changelog>`_."])
 
 setup(
-    name='scaleway-sdk',
-    version=get_version(),
-    description="Tools to query the REST APIs of Scaleway",
-    long_description=get_long_description(),
+    name=PACKAGE_NAME,
+    version=version(),
+    description="Python SDK to query Scaleway APIs.",
+    long_description=long_description(),
+    keywords=['network', 'compute', 'storage', 'api', 'sdk', 'cloud', 'iaas'],
 
     author='Scaleway',
     author_email='opensource@scaleway.com',
     url='https://github.com/scaleway/python-scaleway',
     license='BSD',
 
-    install_requires=REQUIREMENTS,
-
     packages=find_packages(),
-
-    tests_require=[
-        'httpretty >= 0.8.0',
-        'mock',
-    ],
-    test_suite=MODULE_NAME + '.tests',
+    # https://www.python.org/dev/peps/pep-0345/#version-specifiers
+    python_requires='>= 2.7, != 3.0.*, != 3.1.*, != 3.2.*',
+    install_requires=DEPENDENCIES,
+    tests_require=DEPENDENCIES + EXTRA_DEPENDENCIES['tests'],
+    extras_require=EXTRA_DEPENDENCIES,
+    dependency_links=[],
+    test_suite='{}.tests'.format(MODULE_NAME),
 
     classifiers=[
         # See: https://pypi.python.org/pypi?:action=list_classifiers