Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Create 3.0.0-dev.2 #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions 74 CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===================

Expand Down Expand Up @@ -73,6 +146,7 @@ Features

* :gh:`276`: Document how to create a sublass from :class:`VersionInfo` class

* :gh:`213`: Add typing information


Bug Fixes
Expand Down
1 change: 0 additions & 1 deletion 1 changelog.d/169.deprecation.rst

This file was deleted.

10 changes: 0 additions & 10 deletions 10 changelog.d/169.feature.rst

This file was deleted.

8 changes: 0 additions & 8 deletions 8 changelog.d/169.trivial.rst

This file was deleted.

5 changes: 0 additions & 5 deletions 5 changelog.d/304.doc.rst

This file was deleted.

10 changes: 0 additions & 10 deletions 10 changelog.d/304.trivial.rst

This file was deleted.

1 change: 0 additions & 1 deletion 1 changelog.d/305.doc.rst

This file was deleted.

1 change: 0 additions & 1 deletion 1 changelog.d/305.feature.rst

This file was deleted.

12 changes: 6 additions & 6 deletions 12 setup.cfg
Original file line number Diff line number Diff line change
@@ -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 =
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.