From 0b4d4c724f6d86bbc2c964af0463ef28de7c8015 Mon Sep 17 00:00:00 2001 From: Rick Eyre Date: Tue, 17 Feb 2015 11:50:30 -0500 Subject: Adds a new bump version func to the API. --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index a13871c..a6bf947 100644 --- a/README.rst +++ b/README.rst @@ -107,6 +107,22 @@ Obviously, :class:`Versions ` can be compared: >>> semantic_version.Version('0.1.1') <= semantic_version.Version('0.1.1-alpha') False +You can also get a new version that represents a bump in one of the version levels: + +.. code-block:: pycon + + >>> v = semantic_version.Version('0.1.1-pre+build') + >>> new_v = v.next_major() + >>> str(new_v) + '1.0.0' + >>> v = semantic_version.Version('1.1.1-pre+build') + >>> new_v = v.next_minor() + >>> str(new_v) + '1.2.0' + >>> v = semantic_version.Version('1.1.1-pre+build') + >>> new_v = v.next_patch() + >>> str(new_v) + '1.1.2' It is also possible to check whether a given string is a proper semantic version string: -- cgit v1.2.1