Fix git based package versioning for setuptools >= 67.0.0 (#691)

* Fix git based package version

* Use setuptools_scm

Signed-off-by: Dennis Keck <26092524+fellhorn@users.noreply.github.com>

* Fix write to version

Signed-off-by: Dennis Keck <26092524+fellhorn@users.noreply.github.com>

* Fix version var backwards compatibility

Signed-off-by: Dennis Keck <26092524+fellhorn@users.noreply.github.com>

* Revert "Fix version var backwards compatibility"

This reverts commit f9a9238.

* Try - catch version handling

Signed-off-by: Dennis Keck <26092524+fellhorn@users.noreply.github.com>

---------

Signed-off-by: Dennis Keck <26092524+fellhorn@users.noreply.github.com>

.gitignore

@@ -9,3 +9,4 @@ dist
 runs/*
 *.pyc
 mnist
+tensorboardX/_version.py

setup.py

@@ -2,9 +2,8 @@
 # -*- coding: utf-8 -*-
 
 import subprocess
-import os
 import sys
-from setuptools import setup, find_packages
+from setuptools import setup
 from setuptools.command.develop import develop
 from setuptools.command.install import install
 
@@ -31,23 +30,6 @@ def run(self):
     history = history_file.read()
 
 preparing_PyPI_package = 'sdist' in sys.argv or 'bdist_wheel' in sys.argv
-version_git = version = subprocess.check_output(['git', 'describe', '--always']).decode('ascii').strip()
-
-# pass version without using argparse
-# format example: v1.2.3
-publish_version = sys.argv[-1]
-if publish_version[0] == 'v':
-    version_git = publish_version[1:]
-    sys.argv = sys.argv[:-1]
-print(version_git)
-
-if not preparing_PyPI_package:
-    if os.path.exists('.git'):
-        sha = subprocess.check_output(['git', 'rev-parse', 'HEAD']).decode('ascii').strip()
-        version_git = version_git + '+' + sha[:7]
-
-with open('tensorboardX/__init__.py', 'a') as f:
-    f.write('\n__version__ = "{}"\n'.format(version_git))
 
 requirements = [
     'numpy',
@@ -58,7 +40,6 @@ def run(self):
 
 setup(
     name='tensorboardX',
-    version=version_git,
     description='TensorBoardX lets you watch Tensors Flow without Tensorflow',
     long_description=history,
     author='Tzu-Wei Huang',
@@ -67,6 +48,10 @@ def run(self):
     packages=['tensorboardX'],
     include_package_data=True,
     install_requires=requirements,
+    use_scm_version={
+        'write_to': "tensorboardX/_version.py",
+    },
+    setup_requires=['setuptools_scm'],
     license='MIT license',
     zip_safe=False,
     classifiers=[

tensorboardX/__init__.py

@@ -5,7 +5,8 @@
 from .torchvis import TorchVis
 from .writer import FileWriter, SummaryWriter
 from .global_writer import GlobalSummaryWriter
-__version__ = "dev"
-# will be overwritten if run setup.py
-# specifically, `python setup.py install` creates [version in setup.py + git SHA hash]
-# python setup.py sdist creates a decimal version number
+
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "unknown version"