Merge branch 'feature/packaging' into 'master'

Refresh packaging

See merge request python-devs/importlib_resources!87

Author: jaraco

MANIFEST.in

@@ -2,6 +2,8 @@
 
 import sys
 
+from ._compat import metadata
+
 
 __all__ = [
     'Package',
@@ -46,5 +48,4 @@
     del __all__[:3]
 
 
-__version__ = \
-    files('importlib_resources').joinpath('version.txt').read_text().strip()
+__version__ = metadata.version('importlib_resources')

importlib_resources/__init__.py

@@ -29,6 +29,12 @@ class ABC(object):                                          # type: ignore
     FileNotFoundError = OSError                                 # type: ignore
 
 
+try:
+    from importlib import metadata
+except ImportError:
+    import importlib_metadata as metadata  # type: ignore
+
+
 try:
     from zipfile import Path as ZipPath  # type: ignore
 except ImportError:

importlib_resources/_compat.py

@@ -2,8 +2,8 @@
  importlib_resources NEWS
 ==========================
 
-1.1.0 (2020-02-29)
-==================
+v1.1.0
+======
 * Add support for retrieving resources from subdirectories of packages
   through the new ``files()`` function, which returns a ``Traversable``
   object with ``joinpath`` and ``read_*`` interfaces matching those
@@ -21,61 +21,61 @@
   consequence of the ResourceReader interface only operating on
   Python packages).
 
-1.0.2 (2018-11-01)
-==================
+1.0.2
+=====
 * Fix ``setup_requires`` and ``install_requires`` metadata in ``setup.cfg``.
   Given by Anthony Sottile.
 
-1.0.1 (2018-06-29)
-==================
+1.0.1
+=====
 * Update Trove classifiers.  Closes #63
 
-1.0 (2018-06-28)
-================
+1.0
+===
 * Backport fix for test isolation from Python 3.8/3.7.  Closes #61
 
-0.8 (2018-05-17)
-================
+0.8
+===
 * Strip ``importlib_resources.__version__``.  Closes #56
 * Fix a metadata problem with older setuptools.  Closes #57
 * Add an ``__all__`` to ``importlib_resources``.  Closes #59
 
-0.7 (2018-05-15)
-================
+0.7
+===
 * Fix ``setup.cfg`` metadata bug.  Closes #55
 
-0.6 (2018-05-15)
-================
+0.6
+===
 * Move everything from ``pyproject.toml`` to ``setup.cfg``, with the added
   benefit of fixing the PyPI metadata.  Closes #54
 * Turn off mypy's ``strict_optional`` setting for now.
 
-0.5 (2018-05-01)
-================
+0.5
+===
 * Resynchronize with Python 3.7; changes the return type of ``contents()`` to
   be an ``Iterable``.  Closes #52
 
-0.4 (2018-03-27)
-================
+0.4
+===
 * Correctly find resources in subpackages inside a zip file.  Closes #51
 
-0.3 (2018-02-17)
-================
+0.3
+===
 * The API, implementation, and documentation is synchronized with the Python
   3.7 standard library.  Closes #47
 * When run under Python 3.7 this API shadows the stdlib versions.  Closes #50
 
-0.2 (2017-12-13)
-================
+0.2
+===
 * **Backward incompatible change**.  Split the ``open()`` and ``read()`` calls
   into separate binary and text versions, i.e. ``open_binary()``,
   ``open_text()``, ``read_binary()``, and ``read_text()``.  Closes #41
 * Fix a bug where unrelated resources could be returned from ``contents()``.
   Closes #44
 * Correctly prevent namespace packages from containing resources.  Closes #20
 
-0.1 (2017-12-05)
-================
+0.1
+===
 * Initial release.
 
 

importlib_resources/docs/changelog.rst

@@ -33,7 +33,9 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
+    'rst.linker',
+    'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.coverage',
@@ -178,3 +180,16 @@
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     }
+
+
+# For rst.linker, inject release dates into changelog.rst
+link_files = {
+    'changelog.rst': dict(
+        replace=[
+            dict(
+                pattern=r'^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n',
+                with_scm='{text}\n{rev[timestamp]:%Y-%m-%d}\n\n',
+                ),
+            ],
+        ),
+    }

importlib_resources/docs/conf.py

@@ -29,7 +29,7 @@ The documentation here includes a general :ref:`usage <using>` guide and a
 
    using.rst
    migration.rst
-   changelog.rst
+   changelog (links).rst
 
 
 Project details

importlib_resources/docs/index.rst

@@ -1,2 +1,4 @@
 [build-system]
-requires = ["setuptools>=30.3", "wheel"]
+requires = ["setuptools>=30.3", "wheel", "setuptools_scm[toml]>=3.4.1"]
+
+[tool.setuptools_scm]

importlib_resources/version.txt

@@ -1,12 +1,11 @@
 [metadata]
+license_file = LICENSE
 name = importlib_resources
-version = file: importlib_resources/version.txt
 author = Barry Warsaw
 author_email = [email protected]
 url = http://importlib-resources.readthedocs.io/
 description = Read resources from Python packages
 long_description = file: README.rst
-license = Apache Software License
 classifiers =
     Development Status :: 5 - Production/Stable
     Intended Audience :: Developers
@@ -22,6 +21,8 @@ install_requires =
     typing; python_version < '3.5'
     zipp >= 0.4; python_version < '3.8'
     singledispatch; python_version < '3.4'
+    importlib_metadata; python_version < '3.8'
+setup_requires = setuptools_scm[toml] >= 3.4.1
 packages = find:
 
 [options.package_data]
@@ -48,3 +49,4 @@ universal=1
 docs =
     sphinx
     docutils==0.12
+    rst.linker

pyproject.toml

@@ -1,2 +1,3 @@
 from setuptools import setup
-setup()
+
+setup(use_scm_version=True)