* Fix #201: Reformat source code with black

* Add `pyproject.toml` containing black configuration
* Add batch image in `README.rst`
* Reformat source code with `black`

* Add config for flake8

Use max-line-length of 88 (default for black)

* Remove uploading the diff file as artifact
* Use `--check` to test our source code

* Describe each target with `description` keyword;
  useful when running tox as `tox -a -v`
* Move whitelist_externals to `textenv` section
* Use `make` in `docs` target instead of running
  `sphinx-build` directly
* Introduce black target to check for changes in formatting
* Use `posargs` for flake8

* VersionInfo.isvalid(cls, version:str) -> bool
* Add test case
* Describe function in documentation
* Amend pysemver script with "check" subcommand
* Update manpage (pysemver.rst)
* Update `CHANGELOG.rst`

* Use `docformatter` from https://github.com/myint/docformatter/
* Reformat `semver.py` to be compatible with PEP257 docstrings
  with `docformatter -i --pre-summary-newline semver.py`
* `tox.ini`
  - Introduce `docstrings` target which calls `docformatter`
    to check for PEP257 compatible docstrings
  - Introduce a new `check` target which calls `black`, `flake8`, and
    `docstrings`
* `.travis.yml`
  - Run `check` target instead of `flake8`
  - Add `before_install` section to install python3-dev package
    for black

* Use separate cmd_* functions for each subcommand
* Replace which with func keyword
* Use func keyword to store the specific cmd_* function
* Adapt tests
* (Re)format with black
* Clarify return code in manpage (add new section "Return Code")

=> Easier to extend

* Document how to deal with invalid versions
* Use coerce(version) as an example
* Update CHANGELOG.rst

Co-authored-by: scls19fr <[email protected]>

* Raise version number in `__version__`
* Update CHANGELOG
* Mention TestPyPI in `release-procedure.md`
* MANIFEST.in:
  * Exclude `.travis.yml`
  * Exclude `.github` directory (pretty useless in an archive/wheel)
  * Exclude `docs/_build` directory
  * Exclude temporary Python files like `__pycache__`, `*.py[cod]`
  * Include all `*.txt` and `*.rst` files

Co-authored-by: Sebastien Celles <[email protected]>

Co-authored-by: scls19fr <[email protected]>

In class clean, replace super(CleanCommand, self).run() with CleanCommand.run(self)

Co-authored-by: Dennis Menschel <[email protected]>

Co-authored-by: Dennis Menschel <[email protected]>

* Fix typos in `README.rst`.
* Move `coerce()` function into separate file; this was needed
  so it can be both included into the documentation and inside
  `conftest.py`.
* In `docs/usage.rst`:
  - Fix typos
  - Add missing semver module name as prefix
  - Slightly rewrite some doctests which involves dicts
    (unfortunately, order matters still in Python2)
* In `setup.cfg`:
  - Add `--doctest-glob` option to look for all `*.rst` files.
  - Add `testpaths` key to restrict testing paths to current dir
    and `docs`.
* Update `CHANGELOG.rst`

Add better doctest integration into pytest

* Use ".. versionadded::" RST directive in docstrings to
  make it more visible when something was added
* Minor wording fix in docstrings (versions -> version strings)

Add version information in some functions

* Add test cases
  - Add additional test case for "check"
  - test_should_process_check_iscalled_with_valid_version
  - Test also missing finalize_version
  - Test the warning more thoroughly with pytest.warns instead
    of just pytest.deprecated_call

* In `setup.cfg`, add deprecation warnings filter for pytest

* Implement DeprecationWarning with warnings module and
  the new decorator `deprecated`

* Output a DeprecationWarning for the following functions:
  - semver.bump_{major,minor,patch,prerelease,build}
  - semver.format_version
  - semver.finalize_version
  - semver.parse
  - semver.parse_version_info
  - semver.replace
  - semver.VersionInfo._asdict
  - semver.VersionInfo._astuple
  Add also a deprecation notice in the docstrings of these
  functions

* Introduce new public functions:
  - semver.VersionInfo.to_dict (from former _asdict)
  - semver.VersionInfo.to_tuple (from former _astuple)
  - Keep _asdict and _astuple as a (deprecated) function for
    compatibility reasons

* Update CHANGELOG.rst

* Update usage documentation:
  - Move some information to make them more useful for
    for the reader
  - Add deprecation warning
  - Explain how to replace deprecated functions
  - Explain how to display deprecation warnings from semver

* Improve documentation of deprecated functions
  - List deprecated module level functions
  - Make recommendation and show equivalent code
  - Mention that deprecated functions will be replaced in
    semver 3. That means, all deprecated function will be still
    available in semver 2.x.y.

* Move _increment_string into VersionInfo class
  - Makes removing deprecating functions easier as, for example,
    bump_prerelease is no longer dependant from an "external"
    function.
  - Move _LAST_NUMBER regex into VersionInfo class
  - Implement _increment_string as a staticmethod

Co-authored-by: Karol <[email protected]>
Co-authored-by: scls19fr <[email protected]>
Co-authored-by: George Sakkis

Deprecate module level functions

* Module level functions like `semver.bump_version` are still available
  in the documentation, but they play a much less important role now.
  The preferred way is to use semver.Versioninfo instances to use.

* Replace 2.9.2 -> 2.10.0 due to #237

* Fix docstring examples

Shift focus on semver.VersionInfo.* functions

Deprecate:

* `semver.compare` -> `semver.VersionInfo.compare`
* `semver.match` -> `semver.VersionInfo.match`

Change:

* Implementation of `semver.max_ver` and `semver.min_ver`

* Call self.compare(other) in all comparison operators.
* Make sure, "other" is a compatible type (VersionInfo,
  dict, list, tuple, or string)

Fix #236: add missing deprecated functions

* Add __getitem__ to VersionInfo class
* Add test cases
* Add user documentation
* Extend CHANGELOG


Co-authored-by: Thomas Laferriere <[email protected]>
Co-authored-by: Peter Bittner <[email protected]>
Co-authored-by: Karol Werner <[email protected]>
Co-authored-by: Sébastien Celles <[email protected]>

The VersionInfo.compare method allows already VersionInfo, dict,
tuple/list and str.

* Extend list of allowed types in comparator with list and str.
* Rewrite case test_should_not_allow_to_compare_version_with_string ->
  test_should_compare_version_string
* Add new test cases:
  - test_should_compare_version_list
  - test_should_not_allow_to_compare_invalid_versionstring
* Use pytest.mark.parametrize for test_should_compare_version_tuples
* Update usage.rst to document all possibilities
* Update CHANGELOG

Synopsis: semver.VersionInfo.next_version(version, part, prerelease_token="rc")

* Add test cases
  * test_next_version
  * test_next_version_with_invalid_parts
* Reformat code with black
* Document it in usage.rst
* Implement "nextver" subcommand for pysemver command

Co-authored-by: George Sakkis <[email protected]>
Co-authored-By: Karol <[email protected]>

…build

First implementation of next_version

Implement __getitem__ for #138

Fix #244: Allow list & str for comparison

* 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"

Release 2.10.0

Defines default behaviour when executing
`from semver import *` (although it's considered
bad coding practice).

Raise version to 2.10.1.

See also:
https://docs.python.org/3/tutorial/modules.html#importing-from-a-package

Add __all__ to provide explict index of semver

Use obs:// scheme instead of the longer http://. The former
has the additional advantage, that the current release
is automatically detected.

Co-authored-by: Martin Rey <[email protected]>

Simplify openSUSE installation with obs://

* Return VersionInfo instance in VersionInfo.next_version and
  not str when part is major, minor, or patch.
* Change test_next_version_with_versioninfo
  Test for correct return type (should be VersionInfo)
* Update CHANGELOG.rst

Co-authored-by: Thomas Laferriere <[email protected]>

* Type should be VersionInfo instead of str in
  VersionInfo.bump_build and VersionInfo.bump_prerelease
* Make rtype line in docstrings consistent
* Use :class: prefix for VersionInfo object

Co-authored-by: Thomas Laferriere <[email protected]>

Add a new section "Release Policy" to give a
recommendation.

As with the upcoming major 3 release of semver, a lot of
things have been changed. To avoid any surprises for
our users or even break their code base, a short
version restriction can solve that.

This should help users who wants to stay with release 2.

Basically, it boils down to a line like `semver>=2,<3`.
This can be added in any file which lists dependencies.

* Use VersionInfo instead of semver.VersionInfo
* Change order. Deprecation notice should come
  first in docstring

Doc: Add version rule to avoid surpises

Make docstrings consistent

* Update CHANGELOG
* Improve release-procedure.md
* #249: Add release policy and version restriction in documentation to
  help our users which would like to stay on the major 2 release.
* #250: Simplify installation semver on openSUSE with ``obs://``.
* #251: Return type of ``semver.VersionInfo.next_version``
  to always return a ``VersionInfo`` instance.
* #256: Made docstrings consistent

Release 2.10.1

* Fix #260 and add tests for these special cases 
* Fix IndexError not being thrown every time it should
* Update CHANGELOG.rst

Co-authored-by: Tom Schraitle <[email protected]>

Doc: Add missing "install" for openSUSE

* Increase coverage in VersionInfo.compare
* Test __repr__
* Test nextver subcommand
* Run black

* Deprecate functions max_ver and min_ver

* Fix typos in docs

* Document use of builtins max() and min()

* Fix bad doc link and change section name

* Improve documentation with examples of how to use the builtin max and min. Keep the old way of doing for reference.

* Test that max_ver and min_ver are deprecated.

* Add deprecation to CHANGELOG.rst

* Rename removals to deprecations and clean up the CHANGELOG.rst


Co-authored-by: Tom Schraitle <[email protected]>

* Update CHANGELOG.rst
* Raise version number

Create 2.10.2 release (#271)

For contributing to semver, every substantial change
should also introduce a Sphinx directive (versionadded,
versionchanged, or deprecated) to help our readers.

Doc: Mention Sphinx directive for docstrings

* turn VersionInfo.parse into a class method in order to be able to create subclasses
* Integrate test case to test subclass

Co-authored-by: Tom Schraitle <[email protected]>

This fixes problems between different string types. In Python2
str vs. unicode and in Python3 str vs. bytes.

* Add some code from six project
* Suppress two flake8 issues (false positives)
* Update Changelog
* Update CONTRIBUTORS
* Document creating a version from a byte string

Co-authored-by: Eli Bishop <[email protected]>

* #274 / #275 String Types Py2 vs. Py3 compatibility
* #277 Turn VersionInfo.parse into classmethod to allow subclasses
* #286 Add author and update changelog for #276/#277

Disallow negative numbers in major, minor, and patch in
semver.VersionInfo.

Reason: a version can only contain positive numbers according
to the semver.org specification:

"A normal version number MUST take the form X.Y.Z where X, Y, and Z
are non-negative integers, ..."

* #291/#292 Disallow negative numbers in VersionInfo

* Version equality means for semver, that `major`, `minor`, `patch`, and `prerelease`
  parts are equal in both versions you compare. The `build` part is ignored.
* Improve docs to describe version comparison

Related to issue #276

* #283: Ensure equal versions have equal hashes
* Update list of contributors

* Remove targets py27, py34, py35, and pypy from `tox.ini`
* Update `README.rst` and remove anything related to Python2
  Mention maintenance branch `maint/v2`
* `setup.py`
  - Update Trove classifiers
  - Require now Python >=3.6.*
  - Remove Tox and Clean classes, try to make it
    as simple as possible
  - Extract metadata directly from source (affects all the __version__,
    __author__ etc. variables)
* `setup.cfg`
  - Add pycodestyle section
  - Ignore venv directory
* `semver.py`
  - Change version number to "3.0.0-dev.1"
  - Remove old code related to Python2
  - Adjust Python2 vs. Python3 str/bytes
  - Add wheel as another test requirement
  - Add type annotations
  - Remove data types and return types from docstring
* `tox.ini`
  - Remove py27, py34, and py35 (out of maintenance)
  - Add docs to default testenv
  - Remove --universal from bdist_wheel
  - Add mypy target
* test suite:
  - Split test suite into separate files under tests/ dir
  - Move conftests.py -> tests
* Travis: Remove old versions, integrate new
  - Remove 2.7, 3.4, 3.5, and pypy
  - Integrate 3.8, 3.9-dev and nightly builds
  - Allow nightly to fail
  - Add mypy test
* Add .editorconfig to have a consistent editor setup
* Add supported python versions to black config
  (cherry picked from commit d9394af)

Co-authored-by: Thomas Laferriere <[email protected]>

Completely revamp file. Mostly update from
gh://github/gitignore/ and integrate:

* Python
* Global/Kate
* Global/Vim
* Global/VisualStudio
* Global/JetBrains

* Remove Python2
* Use Roboto font family
  Sans: Roboto (for text)
  "Serif": Roboto Slab (for headings)
  Monospace: Roboto Mono (for code)
* Improve CSS navigation
* Create new logo and move it to docs/_static
* Add new section about how to get the version of semver
* Use a more general term (2.x.y) instead of specific versions
* Number sections
* Rework deps for doc build
* Rework release procedure
* Add sphinx-autodoc-typehints dependency for type hints

* Add `changelog.d/.gitignore` to keep this directory
* Create `changelog.d/README.rst` with some descriptions
* Add `changelog.d/_template.rst` as Towncrier template
* Add `[tool.towncrier]` section in pyproject.toml
* Add "changelog" target into `tox.ini`. Use it like "tox -e changes -- CMD"
  whereas CMD is a towncrier command. The default "tox -e changes"
  calls towncrier to create a draft of the changelog file and
  output it to stdout.
* Update documentation and add include a new section "Changelog"
  included from `changelog.d/README.rst`
* Update changelog.d directory and add new files
* Add news file in changelog.d

Co-authored-by: Thomas Laferriere <[email protected]>

Fix #176: Create semver 3.0.0-dev.1

Doc: Disable sphinx-argparse

Remove sphinx from requirements.txt

* Update CHANGELOG
* Make the Quickstart the main page of semver doc.
  It's a bit friendlier than having a sterile table
  of contents.

Create 3.0.0-dev.1 Release

* Bump the dev part to "dev.2"
* Add stubby setup.py file for compatibility with python 3.6
* Deprecate cli functions imported from root
* Revert to `pysemver` as console script.
* Refactor __main__.py
  * add type hints for correctness
* Rename VersionInfo to Version to close #305
* Refactor and integrate suggestion from @tomschr
  * Create :file:`src/semver/cli.py` for all CLI methods
  * Create :file:`src/semver/_deprecated.py` for the ``deprecated`` decorator and other deprecated functions
  * Create :file:`src/semver/__main__.py` to allow calling the CLI using :command:`python -m semver`
  * Create :file:`src/semver/_types.py` to hold type aliases
  * Create :file:`src/semver/version.py` to hold the :class:`VersionInfo` class and its utility functions
  * Create :file:`src/semver/__about__.py` for all the metadata variables
* Adapt infrastructure code to the new project layout.
  * Replace :file:`setup.py` with :file:`setup.cfg` because the :file:`setup.cfg` is easier to use
  * Adapt documentation code snippets where needed
  * Adapt tests
  * Changed the ``deprecated`` to hardcode the ``semver`` package name in the warning.
* Change path for docformatter and run it.
* Remove pyi inclusion from black sine we aren't using them
* Split up changelog to make more sense.
* Add documentation for Version rename
* Increase coverage to 100% in non-deprecated parts.
* Update changelog.d/169.feature.rst

Co-authored-by: Thomas Laferriere <[email protected]>
Co-authored-by: Tom Schraitle <[email protected]>

Acoording to the mentioned PEP:

  "Package maintainers who wish to support type checking
   of their code MUST add a marker file named py.typed
   to their package supporting typing."

Add package_data to setup.cfg to include this marker in dist
and whl file.

Split changelog entries into semver 3 (new) and semver 2 (old).

Create a separate file to describe how to migrate to new
semver3.

* Use sphinx-apidoc to build API documentation
* Amend tox.ini and call sphinx-apidoc
* Remove old autosummary; it turned out it was difficult to
  configure and returned warning messages which were hard to fix.
* Add semver version in footer
* Add semver.__about__ to API doc
  * Unorthodox solution with sed
  * Remove obsolete config variables in docs/config.py
  * Add docs/_api/semver.__about__.rst as a placeholder
* Add changelog.d/304.doc.rst

(An old attempt was to use autosummary from https://stackoverflow.com/a/62613202;
however, that didn't work quite well.)

Co-authored-by: Tom Schraitle <[email protected]>

Create semver package

* Build changelog from news files

Due to https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata
we cannot use the "attr:" type in the keywords author, author_email, maintainer,
description, and maintainer_email.

If we do not change it to literal strings, twine (or PyPI) complains about the metadata
with the following error:

HTTPError: 400 Client Error: 'attr: semver.__about__.__author_email__' is an invalid value for
Author-email.

Create 3.0.0-dev.2

Make link in docs/development.rst

* Remove old occurances of Python 2.7
* Correct wrong single test for tox
* Use better example
* Use references to black, flake8, mypy, and docformatter

Add CONTRIBUTING.rst

* Remove all automatic generation and use a more
  "semi-manual" approach (gives more control)
* Improve docstrings in semver module
* Remove docstrings in some dunder methods; Sphinx
  and autodoc uses the docstring from the parent class
* Remove sphinx-apidoc command from :file:`tox.ini`

We only need to install towncrier, but it is not needed
to install semver too. Therefor, skip the installation
of semver.

Tox: skip installation for changelog target

Fix #310: Correct API documentation

* Correct :class: directive and use :class:`~semver.version.Version`
* Mention the rename of VersionInfo -> Version class
* Remove semver. prefix in doctests to make examples shorter
* Correct some references to dunder methods like __getitem__, __gt__ etc.
* Use :py:exec: reference to Python exceptions.
* Remove inconsistencies and mention module level function as
  deprecated and discouraged from using
* Make empty super() call in semverwithvprefix.py example
* Add changelog.d file

Improve usage section

The former code raised a TypeError exception for comparisons
like __gt__, __lt__ etc. to indicate a wrong type.

However, according to NotImplemented[1] documentation,
we should return(!) NotImplemented (not raise) when a
comparison with an invalid type is not implemented.

[1] https://docs.python.org/3/library/constants.html#NotImplemented