Merge pull request #481 from python-cmd2/version_number

Use setuptools_scm for version number

Author: tleonhardt

.gitignore

@@ -3,6 +3,7 @@ __pycache__
 build
 dist
 cmd2.egg-info
+.eggs
 .cache
 *.pyc
 .tox

cmd2/__init__.py

@@ -1,6 +1,14 @@
 #
 # -*- coding: utf-8 -*-
 """This simply imports certain things for backwards compatibility."""
-from .cmd2 import __version__, Cmd, Statement, EmptyStatement, categorize
+
+from pkg_resources import get_distribution, DistributionNotFound
+try:
+    __version__ = get_distribution(__name__).version
+except DistributionNotFound:
+    # package is not installed
+    pass
+
+from .cmd2 import Cmd, Statement, EmptyStatement, categorize
 from .cmd2 import with_argument_list, with_argparser, with_argparser_and_unknown_args, with_category
-from .pyscript_bridge import CommandResult
+from .pyscript_bridge import CommandResult

cmd2/cmd2.py

@@ -116,8 +116,6 @@ def __subclasshook__(cls, C):
 except ImportError:  # pragma: no cover
     ipython_available = False
 
-__version__ = '0.9.4'
-
 
 # optional attribute, when tagged on a function, allows cmd2 to categorize commands
 HELP_CATEGORY = 'help_category'

docs/conf.py

@@ -52,17 +52,18 @@
 
 # General information about the project.
 project = 'cmd2'
-copyright = '2010-2017, Catherine Devlin and Todd Leonhardt'
+copyright = '2010-2018, Catherine Devlin and Todd Leonhardt'
 author = 'Catherine Devlin and Todd Leonhardt'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = '0.9'
-# The full version, including alpha/beta/rc tags.
-release = '0.9.4'
+from pkg_resources import get_distribution
+# version will look like x.y.z
+version = get_distribution('cmd2').version
+# release will look like x.y
+release = '.'.join(version.split('.')[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -5,7 +5,6 @@
 """
 from setuptools import setup
 
-VERSION = '0.9.4'
 DESCRIPTION = "cmd2 - a tool for building interactive command line applications in Python"
 LONG_DESCRIPTION = """cmd2 is a tool for building interactive command line applications in Python. Its goal is to make
 it quick and easy for developers to build feature-rich and user-friendly interactive command line applications.  It
@@ -60,6 +59,8 @@
 Topic :: Software Development :: Libraries :: Python Modules
 """.splitlines())))
 
+SETUP_REQUIRES = ['setuptools_scm']
+
 INSTALL_REQUIRES = ['pyperclip >= 1.5.27', 'colorama', 'attrs']
 
 EXTRAS_REQUIRE = {
@@ -79,7 +80,7 @@
 
 setup(
     name="cmd2",
-    version=VERSION,
+    use_scm_version=True,
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
     classifiers=CLASSIFIERS,
@@ -91,6 +92,7 @@
     packages=['cmd2'],
     keywords='command prompt console cmd',
     python_requires='>=3.4',
+    setup_requires=SETUP_REQUIRES,
     install_requires=INSTALL_REQUIRES,
     extras_require=EXTRAS_REQUIRE,
 )

tests/test_cmd2.py

@@ -28,9 +28,8 @@
     HELP_HISTORY, SHORTCUTS_TXT, SHOW_TXT, SHOW_LONG, StdOut
 
 
-def test_ver():
-    assert cmd2.__version__ == '0.9.4'
-
+def test_version(base_app):
+    assert cmd2.__version__
 
 def test_empty_statement(base_app):
     out = run_cmd(base_app, '')