ENH: Use setuptools_scm to set the version (mne-tools#11517)

Author: larsoner

.gitignore

@@ -41,6 +41,7 @@ MNE-brainstorm-data*
 physionet-sleep-data*
 MEGSIM*
 build
+mne/_version.py
 coverage
 htmlcov
 .cache/

Makefile

@@ -117,7 +117,7 @@ docstring:
 	@$(PYTESTS) --doctest-modules mne/tests/test_docstring_parameters.py
 
 check-manifest:
-	check-manifest -q --ignore .circleci/config.yml,doc,logo,mne/io/*/tests/data*,mne/io/tests/data,mne/preprocessing/tests/data,.DS_Store
+	check-manifest -q --ignore .circleci/config.yml,doc,logo,mne/io/*/tests/data*,mne/io/tests/data,mne/preprocessing/tests/data,.DS_Store,mne/_version.py
 
 check-readme: clean wheel_quiet
 	twine check dist/*

mne/__init__.py

@@ -16,7 +16,14 @@
 # Dev branch marker is: 'X.Y.devN' where N is an integer.
 #
 
-from ._version import __version__
+try:
+    from importlib.metadata import version
+    __version__ = version("mne")
+except Exception:
+    try:
+        from ._version import __version__
+    except ImportError:
+        __version__ = '0.0.0'
 
 # have to import verbose first since it's needed by many things
 from .utils import (set_log_level, set_log_file, verbose, set_config,

mne/_version.py

@@ -7,4 +7,5 @@ pooch>=1.5
 decorator
 packaging
 jinja2
-importlib_resources>=5.10.2
+importlib_resources>=5.10.2
+importlib_metadata; python_version < '3.8'

requirements_base.txt

@@ -22,25 +22,13 @@ def parse_requirements_file(fname):
     return requirements
 
 
-# get the version (don't import mne here, so dependencies are not needed)
-version = None
-with open(op.join('mne', '_version.py'), 'r') as fid:
-    for line in (line.strip() for line in fid):
-        if line.startswith('__version__'):
-            version = line.split('=')[1].strip().strip('\'')
-            break
-if version is None:
-    raise RuntimeError('Could not determine version')
-
-
 DISTNAME = 'mne'
 DESCRIPTION = 'MNE-Python project for MEG and EEG data analysis.'
 MAINTAINER = 'Alexandre Gramfort'
 MAINTAINER_EMAIL = '[email protected]'
 URL = 'https://mne.tools/dev/'
 LICENSE = 'BSD-3-Clause'
 DOWNLOAD_URL = 'http://github.com/mne-tools/mne-python'
-VERSION = version
 
 
 def package_tree(pkgroot):
@@ -74,7 +62,6 @@ def package_tree(pkgroot):
           description=DESCRIPTION,
           license=LICENSE,
           url=URL,
-          version=VERSION,
           download_url=DOWNLOAD_URL,
           long_description=long_description,
           long_description_content_type='text/x-rst',
@@ -100,6 +87,11 @@ def package_tree(pkgroot):
           platforms='any',
           python_requires='>=3.7',
           install_requires=install_requires,
+          setup_requires=["setuptools>=45", "setuptools_scm>=6.2"],
+          use_scm_version={
+              "write_to": "mne/_version.py",
+              "version_scheme": "release-branch-semver",
+          },
           extras_require={
               'data': data_requires,
               'hdf5': hdf5_requires,