Skip to content

Commit 1ff9360

Browse files
tomschrtomschr
committed
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"
1 parent 22ff5af commit 1ff9360

7 files changed

Lines changed: 36 additions & 10 deletions

File tree

‎CHANGELOG.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Change Log
66
All notable changes to this code base will be documented in this file,
77
in every released version.
88

9-
Version 2.10.0 (WIP)
10-
===================
9+
Version 2.10.0
10+
==============
1111

12-
:Released: 2020-xx-yy
13-
:Maintainer:
12+
:Released: 2020-05-05
13+
:Maintainer: Tom Schraitle
1414

1515
Features
1616
--------

‎CONTRIBUTORS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ Significant contributors
2727
* Ben Finney <ben+python@benfinney.id.au>
2828
* Carles Barrobés <carles@barrobes.com>
2929
* Craig Blaszczyk <masterjakul@gmail.com>
30+
* George Sakkis <gsakkis@users.noreply.github.com>
3031
* Jan Pieter Waagmeester <jieter@jieter.nl>
3132
* Jelo Agnasin <jelo@icannhas.com>
3233
* Karol Werner <karol.werner@ppkt.eu>
3334
* Peter Bittner <django@bittner.it>
3435
* robi-wan <robi-wan@suyu.de>
3536
* T. Jameson Little <t.jameson.little@gmail.com>
3637
* Tom Schraitle <tom_schr@web.de>
38+
* Thomas Laferriere <tlaferriere@users.noreply.github.com>
3739
* Tuure Laurinolli <tuure@laurinolli.net>
3840
* Tyler Cross <tyler@crosscollab.com>
3941
* Zack Lalanne <zack.lalanne@gmail.com>

‎README.rst‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ A Python module for `semantic versioning`_. Simplifies comparing versions.
1717
Major version 3 of semver will contain some incompatible changes:
1818

1919
* removes support for Python 2.7 and 3.3
20-
* removes deprecated functions (see :ref:`sec_replace_deprecated_functions` for
21-
further information).
20+
* removes deprecated functions.
2221

2322
The last version of semver which supports Python 2.7 and 3.4 will be
2423
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:
5958
'build.4'
6059
6160
To raise parts of a version, there are a couple of functions available for
62-
you. The function :func:`semver.VersionInfo.bump_major` leaves the original object untouched, but
63-
returns a new :class:`semver.VersionInfo` instance with the raised major part:
61+
you. The function ``semver.VersionInfo.bump_major`` leaves the original object untouched, but
62+
returns a new ``semver.VersionInfo`` instance with the raised major part:
6463

6564
.. code-block:: python
6665
@@ -75,7 +74,7 @@ It is allowed to concatenate different "bump functions":
7574
>>> ver.bump_major().bump_minor()
7675
VersionInfo(major=4, minor=1, patch=0, prerelease=None, build=None)
7776
78-
To compare two versions, semver provides the `semver.compare` function.
77+
To compare two versions, semver provides the ``semver.compare`` function.
7978
The return value indicates the relationship between the first and second
8079
version:
8180

‎docs/install.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ For Python 3:
1717
1818
pip3 install semver
1919
20+
If you want to install this specific version, you can use the command :command:`pip`
21+
with an URL:
22+
23+
.. parsed-literal::
24+
25+
pip3 install git+https://github.com/python-semver/python-semver.git@|version|
26+
27+
2028
Linux Distributions
2129
-------------------
2230

‎semver.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import warnings
1111

1212

13-
__version__ = "2.9.1"
13+
__version__ = "2.10.0"
1414
__author__ = "Kostiantyn Rybnikov"
1515
__author_email__ = "k-bx@k-bx.com"
1616
__maintainer__ = ["Sebastien Celles", "Tom Schraitle"]

‎setup.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,16 @@ def read_file(filename):
7272
version=package.__version__,
7373
description=package.__doc__.strip(),
7474
long_description=read_file("README.rst"),
75+
long_description_content_type="text/x-rst",
7576
author=package.__author__,
7677
author_email=package.__author_email__,
7778
url="https://github.com/python-semver/python-semver",
7879
download_url="https://github.com/python-semver/python-semver/downloads",
80+
project_urls={
81+
"Documentation": "https://python-semver.rtfd.io",
82+
"Releases": "https://github.com/python-semver/python-semver/releases",
83+
"Bug Tracker": "https://github.com/python-semver/python-semver/issues",
84+
},
7985
py_modules=[package.__name__],
8086
include_package_data=True,
8187
license="BSD",

‎tox.ini‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,14 @@ basepython = python3
5757
deps = sphinx
5858
skip_install = true
5959
commands = make -C docs man
60+
61+
62+
[testenv:prepare-dist]
63+
description = Prepare for TestPyPI
64+
basepython = python3
65+
deps =
66+
wheel
67+
twine
68+
commands =
69+
python3 setup.py sdist bdist_wheel --universal
70+
twine check dist/*

0 commit comments

Comments
 (0)