From 1ff936014677adbe75c1bbba4aa81efdf4fc708b Mon Sep 17 00:00:00 2001 From: Thomas Schraitle Date: Thu, 23 Apr 2020 19:50:19 +0200 Subject: [PATCH] Release 2.10.0 * README.rst: Remove :ref: role as it gives problems in twine * setup.py: add project URLs * Amend list of contributors * Mention how to install semver from master * tox.ini: added prepare-dist target to create distribution (whl and .tar.gz) and check with "twine check" --- CHANGELOG.rst | 8 ++++---- CONTRIBUTORS | 2 ++ README.rst | 9 ++++----- docs/install.rst | 8 ++++++++ semver.py | 2 +- setup.py | 6 ++++++ tox.ini | 11 +++++++++++ 7 files changed, 36 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index b90e3a96..94564c7f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,11 +6,11 @@ Change Log All notable changes to this code base will be documented in this file, in every released version. -Version 2.10.0 (WIP) -=================== +Version 2.10.0 +============== -:Released: 2020-xx-yy -:Maintainer: +:Released: 2020-05-05 +:Maintainer: Tom Schraitle Features -------- diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 98d1d623..0920203c 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -27,6 +27,7 @@ Significant contributors * Ben Finney * Carles BarrobeĢs * Craig Blaszczyk +* George Sakkis * Jan Pieter Waagmeester * Jelo Agnasin * Karol Werner @@ -34,6 +35,7 @@ Significant contributors * robi-wan * T. Jameson Little * Tom Schraitle +* Thomas Laferriere * Tuure Laurinolli * Tyler Cross * Zack Lalanne diff --git a/README.rst b/README.rst index 265aac46..0a1fe664 100644 --- a/README.rst +++ b/README.rst @@ -17,8 +17,7 @@ A Python module for `semantic versioning`_. Simplifies comparing versions. Major version 3 of semver will contain some incompatible changes: * removes support for Python 2.7 and 3.3 - * removes deprecated functions (see :ref:`sec_replace_deprecated_functions` for - further information). + * removes deprecated functions. The last version of semver which supports Python 2.7 and 3.4 will be 2.10.x. However, keep in mind, version 2.10.x is frozen: no new @@ -59,8 +58,8 @@ different parts, use the ``semver.VersionInfo.parse`` function: 'build.4' To raise parts of a version, there are a couple of functions available for -you. The function :func:`semver.VersionInfo.bump_major` leaves the original object untouched, but -returns a new :class:`semver.VersionInfo` instance with the raised major part: +you. 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 @@ -75,7 +74,7 @@ It is allowed to concatenate different "bump functions": >>> ver.bump_major().bump_minor() VersionInfo(major=4, minor=1, patch=0, prerelease=None, build=None) -To compare two versions, semver provides the `semver.compare` function. +To compare two versions, semver provides the ``semver.compare`` function. The return value indicates the relationship between the first and second version: diff --git a/docs/install.rst b/docs/install.rst index 437e3c3d..ca6c1515 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -17,6 +17,14 @@ For Python 3: pip3 install semver +If you want to install this specific version, you can use the command :command:`pip` +with an URL: + +.. parsed-literal:: + + pip3 install git+https://github.com/python-semver/python-semver.git@|version| + + Linux Distributions ------------------- diff --git a/semver.py b/semver.py index 323e49a8..1c7eebb9 100644 --- a/semver.py +++ b/semver.py @@ -10,7 +10,7 @@ import warnings -__version__ = "2.9.1" +__version__ = "2.10.0" __author__ = "Kostiantyn Rybnikov" __author_email__ = "k-bx@k-bx.com" __maintainer__ = ["Sebastien Celles", "Tom Schraitle"] diff --git a/setup.py b/setup.py index 15829461..746c1436 100755 --- a/setup.py +++ b/setup.py @@ -72,10 +72,16 @@ def read_file(filename): version=package.__version__, description=package.__doc__.strip(), long_description=read_file("README.rst"), + long_description_content_type="text/x-rst", author=package.__author__, author_email=package.__author_email__, url="https://github.com/python-semver/python-semver", download_url="https://github.com/python-semver/python-semver/downloads", + project_urls={ + "Documentation": "https://python-semver.rtfd.io", + "Releases": "https://github.com/python-semver/python-semver/releases", + "Bug Tracker": "https://github.com/python-semver/python-semver/issues", + }, py_modules=[package.__name__], include_package_data=True, license="BSD", diff --git a/tox.ini b/tox.ini index 397c2440..833c9655 100644 --- a/tox.ini +++ b/tox.ini @@ -57,3 +57,14 @@ basepython = python3 deps = sphinx skip_install = true commands = make -C docs man + + +[testenv:prepare-dist] +description = Prepare for TestPyPI +basepython = python3 +deps = + wheel + twine +commands = + python3 setup.py sdist bdist_wheel --universal + twine check dist/*