Related pr: #307

• Released
  2020-11-01

• Maintainer
  Tom Schraitle

Documentation: https://python-semver.rtfd.io/en/3.0.0-dev.2/
Full Changelog: 3.0.0-dev.1...3.0.0-dev.2

Deprecations

• #169: Deprecate CLI functions not imported from semver.cli.

Features

• #169: Create semver package and split code among different modules in the packages:
  • Remove semver.py
  • Create src/semver/__init__.py
  • Create src/semver/cli.py for all CLI methods
  • Create src/semver/_deprecated.py for the deprecated decorator and other deprecated functions
  • Create src/semver/__main__.py to allow calling the CLI using python -m semver
  • Create src/semver/_types.py to hold type aliases
  • Create src/semver/version.py to hold the Version class (old name VersionInfo) and its utility functions
  • Create src/semver/__about__.py for all the metadata variables
• #305: Rename VersionInfo to Version but keep an alias for compatibility

Improved Documentation

• #304: Several improvements in documentation:
  • Reorganize API documentation.
  • Add migration chapter from semver2 to semver3.
  • Distinguish between changlog for version 2 and 3
• #305: Add note about Version rename.

Trivial/Internal Changes

• #169: Adapted infrastructure code to the new project layout.

  • Replace setup.py with setup.cfg because the
    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.

  Increase coverage to 100% for all non-deprecated APIs

• #304: Support PEP-561 py.typed.

  According 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.

Contributors

(in alphabetical order)

• @tlaferriere

Thanks to all! ❤️