Merge pull request #493 from ReFirmLabs/version_py

New and improved version.py

.gitignore

 build
 dist
-version.py
 .coverage
 *.extracted
 *.pyc

setup.py

@@ -8,10 +8,9 @@ from distutils.core import setup, Command
 from distutils.dir_util import remove_tree
 
 MODULE_NAME = "binwalk"
-MODULE_VERSION = "2.2.0"
+MODULE_VERSION = "2.2.1"
 SCRIPT_NAME = MODULE_NAME
 MODULE_DIRECTORY = os.path.dirname(os.path.realpath(__file__))
-VERSION_FILE = os.path.join(MODULE_DIRECTORY, "src", "binwalk", "core", "version.py")
 
 # Python3 has a built-in DEVNULL; for Python2, we have to open
 # os.devnull to redirect subprocess stderr output to the ether.
@@ -221,13 +220,6 @@ class CleanCommand(Command):
         pass
 
     def run(self):
-        sys.stdout.write("removing '%s'\n" % (VERSION_FILE))
-
-        try:
-            os.remove(VERSION_FILE)
-        except OSError as e:
-            sys.stderr.write("failed to remove file '%s': %s\n" % (VERSION_FILE, str(e)))
-
         try:
             remove_tree(os.path.join(MODULE_DIRECTORY, "build"))
         except KeyboardInterrupt as e:
@@ -326,20 +318,6 @@ install_data_files = []
 for data_dir in ["magic", "config", "plugins", "modules", "core"]:
     install_data_files.append("%s%s*" % (data_dir, os.path.sep))
 
-# If doing a build or installation, then create a version.py file
-# which defines the current binwalk version. This file is excluded
-# from git in the .gitignore file.
-if 'install' in ' '.join(sys.argv) or 'build' in ' '.join(sys.argv) or 'sdist' in ' '.join(sys.argv):
-    sys.stdout.write("creating %s\n" % (VERSION_FILE))
-
-    try:
-        with open(VERSION_FILE, "w") as fp:
-            fp.write("# This file has been auto-generated by setup.py\n")
-            fp.write('__version__ = "%s"\n' % MODULE_VERSION)
-    except IOError as e:
-        sys.stderr.write("failed to create file %s: %s\n" % (VERSION_FILE, str(e)))
-        sys.exit(1)
-
 # Install the module, script, and support files
 setup(
     name=MODULE_NAME,

src/binwalk/core/version.py

+try:
+    from importlib import metadata
+    get_version = lambda : metadata.version("binwalk")
+except ImportError:
+    try:
+        # Running on pre-3.8 Python; use importlib-metadata package
+        import importlib_metadata as metadata
+        get_version = lambda: metadata.version("binwalk")
+    except ImportError:
+        # 3rd fallback via pkg_resources
+        import pkg_resources
+        get_version = lambda : pkg_resources.get_distribution("binwalk").version
+
+__version__ = get_version()