diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 00bc7813..26f8ff79 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -16,6 +16,79 @@ in our repository. .. towncrier release notes start +Version 3.0.0-dev.2 +=================== + +:Released: 2020-11-01 +:Maintainer: Tom Schraitle + + +Deprecations +------------ + +* :gh:`169`: Deprecate CLI functions not imported from ``semver.cli``. + + + +Features +-------- + +* :gh:`169`: Create semver package and split code among different modules in the packages. + + * Remove :file:`semver.py` + * Create :file:`src/semver/__init__.py` + * 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:`Version` class (old name :class:`VersionInfo`) and its utility functions + * Create :file:`src/semver/__about__.py` for all the metadata variables + +* :gh:`305`: Rename :class:`VersionInfo` to :class:`Version` but keep an alias for compatibility + + + +Improved Documentation +---------------------- + +* :gh:`304`: Several improvements in documentation: + + * Reorganize API documentation. + * Add migration chapter from semver2 to semver3. + * Distinguish between changlog for version 2 and 3 + +* :gh:`305`: Add note about :class:`Version` rename. + + + +Trivial/Internal Changes +------------------------ + +* :gh:`169`: Adapted 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. + + Increase coverage to 100% for all non-deprecated APIs + +* :gh:`304`: Support PEP-561 :file:`py.typed`. + + According to the mentioned PEP: + + "Package maintainers who wish to support type checking + of their code MUST add a marker file named :file:`py.typed` + to their package supporting typing." + + Add package_data to :file:`setup.cfg` to include this marker in dist + and whl file. + + + +---- + + Version 3.0.0-dev.1 =================== @@ -73,6 +146,7 @@ Features * :gh:`276`: Document how to create a sublass from :class:`VersionInfo` class +* :gh:`213`: Add typing information Bug Fixes diff --git a/changelog.d/169.deprecation.rst b/changelog.d/169.deprecation.rst deleted file mode 100644 index 9ce5ef6b..00000000 --- a/changelog.d/169.deprecation.rst +++ /dev/null @@ -1 +0,0 @@ -Deprecate CLI functions not imported from ``semver.cli``. \ No newline at end of file diff --git a/changelog.d/169.feature.rst b/changelog.d/169.feature.rst deleted file mode 100644 index 1b762676..00000000 --- a/changelog.d/169.feature.rst +++ /dev/null @@ -1,10 +0,0 @@ -Create semver package and split code among different modules in the packages. - -* Remove :file:`semver.py` -* Create :file:`src/semver/__init__.py` -* 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:`Version` class (old name :class:`VersionInfo`) and its utility functions -* Create :file:`src/semver/__about__.py` for all the metadata variables diff --git a/changelog.d/169.trivial.rst b/changelog.d/169.trivial.rst deleted file mode 100644 index 536e2b88..00000000 --- a/changelog.d/169.trivial.rst +++ /dev/null @@ -1,8 +0,0 @@ -Adapted 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. - -Increase coverage to 100% for all non-deprecated APIs \ No newline at end of file diff --git a/changelog.d/304.doc.rst b/changelog.d/304.doc.rst deleted file mode 100644 index 3fa09bc6..00000000 --- a/changelog.d/304.doc.rst +++ /dev/null @@ -1,5 +0,0 @@ -Several improvements in documentation: - -* Reorganize API documentation. -* Add migration chapter from semver2 to semver3. -* Distinguish between changlog for version 2 and 3 diff --git a/changelog.d/304.trivial.rst b/changelog.d/304.trivial.rst deleted file mode 100644 index fe0d012a..00000000 --- a/changelog.d/304.trivial.rst +++ /dev/null @@ -1,10 +0,0 @@ -Support PEP-561 :file:`py.typed`. - -According to the mentioned PEP: - - "Package maintainers who wish to support type checking - of their code MUST add a marker file named :file:`py.typed` - to their package supporting typing." - -Add package_data to :file:`setup.cfg` to include this marker in dist -and whl file. diff --git a/changelog.d/305.doc.rst b/changelog.d/305.doc.rst deleted file mode 100644 index 1ce69247..00000000 --- a/changelog.d/305.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Add note about :class:`Version` rename. \ No newline at end of file diff --git a/changelog.d/305.feature.rst b/changelog.d/305.feature.rst deleted file mode 100644 index 98ef9665..00000000 --- a/changelog.d/305.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Rename :class:`VersionInfo` to :class:`Version` but keep an alias for compatibility \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index 873be36d..681240ac 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,18 +1,18 @@ # # Metadata for setup.py # -# See https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html +# See https://setuptools.rtfd.io/en/latest/userguide/declarative_config.html [metadata] name = semver version = attr: semver.__about__.__version__ -description = attr: semver.__about__.__description__ +description = Python helper for Semantic Versioning (http://semver.org) long_description = file: README.rst long_description_content_type = text/x-rst -author = attr: semver.__about__.__author__ -author_email = attr: semver.__about__.__author_email__ -maintainer = attr: semver.__about__.__maintainer__ -maintainer_email = attr: semver.__about__.__maintainer_email__ +author = Kostiantyn Rybnikov +author_email = k-bx@k-bx.com +maintainer = Sebastien Celles, Tom Schraitle +maintainer_email = s.celles@gmail.com url = https://github.com/python-semver/python-semver download_url = https://github.com/python-semver/python-semver/downloads project_urls = pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy