Merge pull request #46 from mdickinson/fix/version-number

Add bigfloat.__version__ and centralise version numbers.

Author: mdickinson

INSTALL.rst

@@ -14,7 +14,7 @@ Installation from a release tarball
 The instructions cover installation from either a repository clone,
 or a source distribution tarball.  After cloning the repository
 or unpacking the tarball, you should have a top-level directory
-named something like ``bigfloat-0.3.0``.
+named something like ``bigfloat-0.4.0``.
 
 (1) Enter that top-level directory and execute the command::
 
@@ -62,7 +62,7 @@ named something like ``bigfloat-0.3.0``.
         ...
         1.4142135623730950488016887242096980785696718753769480731766796
 
-If installation was successful, the ``bigfloat-0.3.0`` directory that you
+If installation was successful, the ``bigfloat-0.4.0`` directory that you
 created can now be deleted.
 
 

RELEASING.rst

@@ -8,7 +8,7 @@ Notes on creating a release.  These notes apply my own system, currently OS X
 
 1. Create a release branch::
 
-      git checkout release/0.3.0
+      git checkout release/0.4.0
 
 2. Update version numbers if necessary.  Places that need to be updated
    include::
@@ -27,7 +27,7 @@ Notes on creating a release.  These notes apply my own system, currently OS X
 
 4. When satisfied, tag the release::
 
-      git tag -a v0.3.0
+      git tag -a v0.4.0
 
 5. Upload the release to PyPI.  Register first if necessary::
 

bigfloat/__init__.py

@@ -16,6 +16,9 @@
 # along with the bigfloat package.  If not, see <http://www.gnu.org/licenses/>.
 
 __all__ = [
+    # version string for bigfloat
+    '__version__',
+
     # main class
     'BigFloat',
 
@@ -167,6 +170,8 @@
 
 )
 
+from bigfloat.version import __version__
+
 from mpfr import (
     # MPFR Version information
     MPFR_VERSION,

bigfloat/test/test_bigfloat.py

@@ -31,6 +31,9 @@
 _builtin_abs = abs
 
 from bigfloat import (
+    # version number
+    __version__,
+
     # main class
     BigFloat,
 
@@ -133,6 +136,9 @@ class BigFloatTests(unittest.TestCase):
     def setUp(self):
         setcontext(DefaultContext)
 
+    def test_version(self):
+        self.assertIsInstance(__version__, str)
+
     def assertIdenticalFloat(self, x, y):
         if not (isinstance(x, float) and isinstance(y, float)):
             raise ValueError("Expected x and y to be floats "

bigfloat/version.py

@@ -0,0 +1,34 @@
+# Copyright 2009--2014 Mark Dickinson.
+#
+# This file is part of the bigfloat package.
+#
+# The bigfloat package is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# The bigfloat package is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with the bigfloat package.  If not, see <http://www.gnu.org/licenses/>.
+
+major = 0
+minor = 4
+patch = 0
+prerelease = 'dev'
+
+if prerelease:
+    __version__ = "{0}.{1}.{2}-{3}".format(major, minor, patch, prerelease)
+else:
+    __version__ = "{0}.{1}.{2}".format(major, minor, patch)
+
+# Release and version for Sphinx purposes.
+
+# The short X.Y version.
+version = "{0}.{1}".format(major, minor)
+
+# The full version, including patchlevel and alpha/beta/rc tags.
+release = __version__

docs/source/conf.py

@@ -59,9 +59,11 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3'
+import bigfloat.version
+version = bigfloat.version.version
+
 # The full version, including alpha/beta/rc tags.
-release = '0.3.0'
+release = bigfloat.version.release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -247,9 +247,20 @@
 """.splitlines()
 
 
+def get_version_info():
+    """Extract version information as a dictionary from version.py."""
+    version_info = {}
+    with open(os.path.join("bigfloat", "version.py"), 'r') as f:
+        version_code = compile(f.read(), "version.py", 'exec')
+        exec(version_code, version_info)
+    return version_info
+
+
+version_info = get_version_info()
+
 setup(
     name='bigfloat',
-    version='0.3.0',
+    version=version_info,
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
     author='Mark Dickinson',