Use setuptools_scm for versioning, fixes #1333

.gitignore

@@ -10,6 +10,7 @@ __pycache__
 
 # ignore version cache file (generated automatically when setup.py is run)
 ctapipe/_version_cache.py
+ctapipe/version.py
 
 # Ignore .c files by default to avoid including generated code. If you want to
 # add a non-generated .c extension, use `git add -f filename.c`.

MANIFEST.in

@@ -3,11 +3,7 @@ include CHANGES.rst
 
 include setup.cfg
 
-recursive-include *.pyx *.c *.pxd
 recursive-include docs *
-recursive-include licenses *
-recursive-include cextern *
-recursive-include scripts *
 
 prune build
 prune docs/_build

ctapipe/__init__.py

@@ -2,7 +2,6 @@
 """
 ctapipe - CTA Python pipeline experimental version
 """
+from .version import __version__
 
-from . import version
-
-__version__ = version.get_version(pep440=False)
+__all__ = ['__version__']

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools >= 40.6.0", "wheel"]
+requires = ["setuptools >= 40.6.0", "wheel", "setuptools_scm[toml]>=3.4"]
 build-backend = "setuptools.build_meta"
 
 [tool.black]

setup.py

@@ -3,16 +3,8 @@
 
 # import ah_bootstrap
 from setuptools import setup, find_packages
-
-import sys
 import os
 
-# pep 517 builds do not have cwd in PATH by default
-sys.path.insert(0, os.path.dirname(__file__))
-# Get the long and version description from the package's docstring
-import ctapipe  # noqa
-
-
 # Define entry points for command-line scripts
 # TODO: this shuold be automated (e.g. look for main functions and
 # rename _ to -, and prepend 'ctapipe'
@@ -48,11 +40,21 @@
     "graphviz",
 ]
 
-ctapipe.version.update_release_version()
+
+VERSION_TEMPLATE = """
+# DO NOT MANUALLY EDIT THIS FILE, IT IS AUTOGENERATED BY SETUP
+# Note that we need to fall back to the hard-coded version if either
+# setuptools_scm can't be imported or setuptools_scm can't determine the
+# version, so we catch the generic 'Exception'.
+try:
+    from setuptools_scm import get_version
+    __version__ = get_version(root='..', relative_to=__file__)
+except Exception:
+    __version__ = '{version}'
+""".lstrip()
 
 setup(
     packages=find_packages(),
-    version=ctapipe.version.get_version(pep440=True),
     python_requires=">=3.7",
     install_requires=[
         "astropy>=3,<5",
@@ -79,8 +81,12 @@
         "tests": tests_require,
         "docs": docs_require,
     },
+    use_scm_version={
+        'write_to': os.path.join('ctapipe', 'version.py'),
+        'write_to_template': VERSION_TEMPLATE,
+    },
     tests_require=tests_require,
-    setup_requires=["pytest_runner"],
+    setup_requires=['pytest_runner', 'setuptools_scm'],
     classifiers=[
         "Intended Audience :: Science/Research",
         "License :: OSI Approved :: BSD License",