Merge pull request #953 from dhellmann/drop-pkg-resources

replace pkg_resources with importlib.metadata

Author: tleonhardt

cmd2/__init__.py

@@ -3,10 +3,15 @@
 # flake8: noqa F401
 """This simply imports certain things for backwards compatibility."""
 
-from pkg_resources import get_distribution, DistributionNotFound
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    # For python 3.8 and later
+    import importlib.metadata as importlib_metadata
+except ImportError:
+    # For everyone else
+    import importlib_metadata
+try:
+    __version__ = importlib_metadata.version(__name__)
+except importlib_metadata.PackageNotFoundError:
     # package is not installed
     pass
 

docs/conf.py

@@ -19,7 +19,7 @@
 """
 # Import for custom theme from Read the Docs
 import sphinx_rtd_theme
-from pkg_resources import get_distribution
+import cmd2
 
 # -- General configuration -----------------------------------------------------
 
@@ -57,7 +57,7 @@
 # built documents.
 #
 # version will look like x.y.z
-version = get_distribution('cmd2').version
+version = cmd2.__version__
 # release will look like x.y
 release = '.'.join(version.split('.')[:2])
 

plugins/ext_test/cmd2_ext_test/__init__.py

@@ -5,16 +5,20 @@
 An overview of what myplugin does.
 """
 
-from pkg_resources import DistributionNotFound, get_distribution
+try:
+    # For python 3.8 and later
+    import importlib.metadata as importlib_metadata
+except ImportError:
+    # For everyone else
+    import importlib_metadata
+try:
+    __version__ = importlib_metadata.version(__name__)
+except importlib_metadata.PackageNotFoundError:
+    # package is not installed
+    __version__ = 'unknown'
 
 from .cmd2_ext_test import ExternalTestMixin
 
 __all__ = [
     'ExternalTestMixin'
 ]
-
-
-try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
-    __version__ = 'unknown'

setup.py

@@ -36,6 +36,7 @@
 INSTALL_REQUIRES = [
     'attrs >= 16.3.0',
     'colorama >= 0.3.7',
+    'importlib_metadata>=1.7.0;python_version<"3.8"',
     'pyperclip >= 1.6',
     'setuptools >= 34.4',
     'wcwidth >= 0.1.7',