Add __version__ to top level module. Closes hardbyte#142

hardbyte · hardbyte · commit af05d661e586 · 2017-02-14T20:01:59.000+11:00
Use same version within the setup script and documentation.
diff --git a/can/__init__.py b/can/__init__.py
@@ -2,6 +2,9 @@
 can is an object-orient Controller Area Network interface module.
 """
 import logging
+
+__version__ = "2.0.0-alpha.2"
+
 log = logging.getLogger('can')
 
 rc = dict()
diff --git a/can/util.py b/can/util.py
@@ -54,8 +54,10 @@ def load_file_config(path=None):
         interface = socketcan
         channel = can0
 
-    :param path: path to config file. If not specified, several sensible
-    default locations are tried depending on platform.
+    :param path:
+        path to config file. If not specified, several sensible
+        default locations are tried depending on platform.
+
     """
     config = ConfigParser()
     if path is None:
diff --git a/doc/conf.py b/doc/conf.py
@@ -10,20 +10,20 @@
 # General information about the project.
 project = u'python-can'
 
-# 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 = '2.0'
-# The full version, including alpha/beta/rc tags.
-release = '2.0.0-alpha.1'
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
 
+import can
+# The version info for the project, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = can.__version__.split('-')[0]
+release = can.__version__
+
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
@@ -102,15 +102,9 @@
 # The default autodoc directive flags
 autodoc_default_flags = ['members', 'show-inheritance']
 
-# TODO: Enable links to python standard library docs
-#intersphinx_mapping = {}
-
 # Keep cached intersphinx inventories indefinitely
 intersphinx_cache_limit = -1
 
-# Include todos in the output
-todo_include_todos = True
-
 # -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
diff --git a/setup.py b/setup.py
@@ -1,18 +1,21 @@
 """
 python-can requires the setuptools package to be installed.
 """
-
+import re
 import logging
 from setuptools import setup, find_packages
 
-__version__ = "2.0.0-alpha.1"
+with open('can/__init__.py', 'r') as fd:
+    version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]',
+                        fd.read(), re.MULTILINE).group(1)
+
 
 logging.basicConfig(level=logging.WARNING)
 
 setup(
     name="python-can",
     url="https://github.com/hardbyte/python-can",
-    version=__version__,
+    version=version,
     packages=find_packages(),
     author="Brian Thorne",
     author_email="hardbyte@gmail.com",
