Fix #167: Introdue SEMVER_SPEC_VERSION

Global constant, definies the implemented semantic version specification
python-semver · Oct 13, 2019 · f673bf6 · f673bf6
1 parent 1f7778a
commit f673bf6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -24,6 +24,7 @@ Features
 * :gh:`142` (:pr:`143`): Improved usage section
 * :gh:`145` (:pr:`146`): Added posargs in :file:`tox.ini`
 * :pr:`157`: Introduce :file:`conftest.py` to improve doctests
+* :gh:`167` (:pr:`168`): Introduced global constant :data:`SEMVER_SPEC_VERSION`
 
 Bug Fixes
 ---------

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -11,6 +11,17 @@ Each type can be converted into the other, if the minimum requirements
 are met.
 
 
+Knowing the Implemented semver.org Version
+------------------------------------------
+
+The semver.org is the authorative specification of how semantical versioning is
+definied. To know which version of semver.org is implemented in the semver
+libary, use the following constant::
+
+   >>> semver.SEMVER_SPEC_VERSION
+   '2.0.0'
+
+
 Creating a Version
 ------------------
 

diff --git a/semver.py b/semver.py
@@ -35,6 +35,10 @@
 
 _LAST_NUMBER = re.compile(r'(?:[^\d]*(\d+)[^\d]*)+')
 
+#: Contains the implemented semver.org version of the spec
+SEMVER_SPEC_VERSION = "2.0.0"
+
+
 if not hasattr(__builtins__, 'cmp'):
     def cmp(a, b):
         return (a > b) - (a < b)