Browse Source

set module version string via setuptools_scm's `write_to` option

https://github.com/pypa/setuptools_scm/blob/04bde2dc07839780e7dab33f6e738b42ca963677/README.rst#configuration-parameters
Fabian Peter Hammerle 5 years ago
parent
commit
904501c765
4 changed files with 14 additions and 3 deletions
  1. 1 0
      .gitignore
  2. 4 0
      freesurfer_volume_reader/__init__.py
  3. 3 1
      setup.py
  4. 6 2
      tests/init_test.py

+ 1 - 0
.gitignore

@@ -1,3 +1,4 @@
 .coverage
 build/
 dist/
+version.py

+ 4 - 0
freesurfer_volume_reader/__init__.py

@@ -22,6 +22,10 @@ import typing
 
 import pandas
 
+import freesurfer_volume_reader.version
+
+__version__ = freesurfer_volume_reader.version.version
+
 
 def parse_version_string(version_string: str) -> typing.Tuple[typing.Union[int, str]]:
     return tuple(int(p) if p.isdigit() else p for p in version_string.split('.'))

+ 3 - 1
setup.py

@@ -1,3 +1,5 @@
+import os
+
 import setuptools
 
 import freesurfer_volume_reader
@@ -7,7 +9,7 @@ LONG_DESCRIPTION = freesurfer_volume_reader.__doc__.strip()
 
 setuptools.setup(
     name='freesurfer-volume-reader',
-    use_scm_version=True,
+    use_scm_version={'write_to': os.path.join('freesurfer_volume_reader', 'version.py')},
     description=LONG_DESCRIPTION.split(sep='\n', maxsplit=1)[0],
     long_description=LONG_DESCRIPTION,
     author='Fabian Peter Hammerle',

+ 6 - 2
tests/init_test.py

@@ -1,7 +1,11 @@
 import pytest
 
-from freesurfer_volume_reader import parse_version_string, remove_group_names_from_regex, \
-                                     VolumeFile
+from freesurfer_volume_reader import __version__, parse_version_string, \
+                                     remove_group_names_from_regex, VolumeFile
+
+
+def test_module_version():
+    assert len(__version__) >= len('0.1.0')
 
 
 @pytest.mark.parametrize(('version_string', 'expected_tuple'), [