Metadata-Version: 1.2
Name: semver
Version: 2.9.1
Summary: Python helper for Semantic Versioning (http://semver.org/)
Home-page: https://github.com/python-semver/python-semver
Author: Kostiantyn Rybnikov
Author-email: k-bx@k-bx.com
License: BSD
Download-URL: https://github.com/python-semver/python-semver/downloads
Description: Quickstart
        ==========
        
        .. teaser-begin
        
        A Python module for `semantic versioning`_. Simplifies comparing versions.
        
        |build-status| |python-support| |downloads| |license| |docs| |black|
        
        .. teaser-end
        
        .. note::
        
           With version 2.9.0 we've moved the GitHub project. The project is now
           located under the organization ``python-semver``.
           The complete URL is::
        
               https://github.com/python-semver/python-semver
        
           If you still have an old repository, correct your upstream URL to the new URL::
        
               $ git remote set-url upstream git@github.com:python-semver/python-semver.git
        
        
        The module follows the ``MAJOR.MINOR.PATCH`` style:
        
        * ``MAJOR`` version when you make incompatible API changes,
        * ``MINOR`` version when you add functionality in a backwards compatible manner, and
        * ``PATCH`` version when you make backwards compatible bug fixes.
        
        Additional labels for pre-release and build metadata are supported.
        
        
        .. warning::
        
           Major version 3.0.0 of semver will remove support for Python 2.7 and 3.4.
        
           As anything comes to an end, this project will focus on Python 3.x.
           New features and bugfixes will be integrated only into the 3.x.y branch
           of semver.
        
           The last version of semver which supports Python 2.7 and 3.4 will be
           2.9.x. However, keep in mind, version 2.9.x is frozen: no new
           features nor backports will be integrated.
        
           We recommend to upgrade your workflow to Python 3.x to gain support,
           bugfixes, and new features.
        
        
        To import this library, use:
        
        .. code-block:: python
        
            >>> import semver
        
        Working with the library is quite straightforward. To turn a version string into the
        different parts, use the `semver.parse` function:
        
        .. code-block:: python
        
            >>> ver = semver.parse('1.2.3-pre.2+build.4')
            >>> ver['major']
            1
            >>> ver['minor']
            2
            >>> ver['patch']
            3
            >>> ver['prerelease']
            'pre.2'
            >>> ver['build']
            'build.5'
        
        To raise parts of a version, there are a couple of functions available for
        you. The `semver.parse_version_info` function converts a version string
        into a `semver.VersionInfo` class. The function
        `semver.VersionInfo.bump_major` leaves the original object untouched, but
        returns a new `semver.VersionInfo` instance with the raised major part:
        
        .. code-block:: python
        
            >>> ver = semver.parse_version_info("3.4.5")
            >>> ver.bump_major()
            VersionInfo(major=4, minor=0, patch=0, prerelease=None, build=None)
        
        It is allowed to concatenate different "bump functions":
        
        .. code-block:: python
        
            >>> ver.bump_major().bump_minor()
            VersionInfo(major=4, minor=0, patch=1, prerelease=None, build=None)
        
        To compare two versions, semver provides the `semver.compare` function.
        The return value indicates the relationship between the first and second
        version:
        
        .. code-block:: python
        
            >>> semver.compare("1.0.0", "2.0.0")
            -1
            >>> semver.compare("2.0.0", "1.0.0")
            1
            >>> semver.compare("2.0.0", "2.0.0")
            0
        
        
        There are other functions to discover. Read on!
        
        
        .. |latest-version| image:: https://img.shields.io/pypi/v/semver.svg
           :alt: Latest version on PyPI
           :target: https://pypi.org/project/semver
        .. |build-status| image:: https://travis-ci.com/python-semver/python-semver.svg?branch=master
           :alt: Build status
           :target: https://travis-ci.com/python-semver/python-semver
        .. |python-support| image:: https://img.shields.io/pypi/pyversions/semver.svg
           :target: https://pypi.org/project/semver
           :alt: Python versions
        .. |downloads| image:: https://img.shields.io/pypi/dm/semver.svg
           :alt: Monthly downloads from PyPI
           :target: https://pypi.org/project/semver
        .. |license| image:: https://img.shields.io/pypi/l/semver.svg
           :alt: Software license
           :target: https://github.com/python-semver/python-semver/blob/master/LICENSE.txt
        .. |docs| image:: https://readthedocs.org/projects/python-semver/badge/?version=latest
           :target: http://python-semver.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        .. _semantic versioning: http://semver.org/
        .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
            :target: https://github.com/psf/black
            :alt: Black Formatter
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
