Tags: python-semver/python-semver
Tags
Version 3.0.3 * #453: The check in `_comparator` does not match the check in `Version.compare`. This breaks comparision with subclasses. * #435: Several small improvements for documentation: * Add meta description to improve SEO * Use canonicals on ReadTheDocs (commit 87f639f) * Pin versions for reproducable doc builds (commit 03fb990) * Add missing `.readthedocs.yaml` file (commit ec9348a) * Correct some smaller issues when building (commit f65feab) * #436: Move search box more at the top. This makes it easier for users as if the TOC is long, the search box isn't visible anymore. * #439: Improve type hints to fix TODOs * #440: Update workflow file * #446: Add Python 3.13 to GitHub Actions * #447: Modernize project configs with `pyproject.toml` and use Astral's uv command. * In `pyproject.toml`: * Move all project related data from `setup.cfg` to `pyproject.toml` * Use new dependency group from PEP-735 * Consolidate flake8, isort, pycodestyle with ruff * Split towncrier config type "trivial" into "trivial" and "internal" * Create config file for ruff (`.ruff.toml`) * Create config file for pytest (`.pytest.ini`) * Simplify `tox.ini` and remove old stuff * Document installation with new `uv` command * Simplify Sphinx config with `find_version()` * Update the authors * Use `uv` in GitHub Action `python-testing.yml` workflow * Update `release-procedure.md`. * #451: Turn our Markdown issue templates into YAML * #438`: Replace organization placeholder in license * #445`: Improve private `_nat_cmp` method: * Remove obsolete else. * Find a better way to identify digits without the `re` module. * Fix docstring in `Version.compare`
Version 3.0.2 Bug Fixes * PR#418: Replace :class:`~collection.OrderedDict` with :class:`dict`. The dict datatype is ordered since Python 3.7. As we do not support Python 3.6 anymore, it can be considered safe to avoid :class:`~collection.OrderedDict`. Related to :gh:`419`. * PR#426: Fix :meth:`~semver.version.Version.replace` method to use the derived class of an instance instead of :class:`~semver.version.Version` class. Improved Documentation * PR#431: Clarify version policy for the different semver versions (v2, v3, >v3) and the supported Python versions. * #432: Improve external doc links to Python and Pydantic. Features * PR#417: Amend GitHub Actions to check against MacOS. Trivial/Internal Changes * PR#420: Introduce :py:class:`~typing.ClassVar` for some :class:`~semver.version.Version` class variables, mainly :data:`~semver.version.Version.NAMES` and some private. * PR#421: Insert mypy configuration into :file:`pyproject.toml` and remove config options from :file:`tox.ini`.
Version: 3.0.0-rc.1 * Combine all dev releases together in one changelog * Remove all changelog.d entries and integrate it into CHANGELOG * Move dev releases to file changelog-semver3-devel.rst * Split contributing into different sections * Some doc polishing; use :meth: consistently for semver.Version methods * Fix also some doc bugs
Version: 3.0.0-dev.4 Following issues/PRs were fixed for this release: Bug Fixes * #374: Correct Towncrier’s config entries in the pyproject.toml file. The old entries [[tool.towncrier.type]] are deprecated and need to be replaced by [tool.towncrier.fragment.<TYPE>]. Deprecations * #372: Deprecate support for Python 3.6. Python 3.6 reached its end of life and isn’t supported anymore. At the time of writing (Dec 2022), the lowest version is 3.7. Although the poll didn’t cast many votes, the majority agree to remove support for Python 3.6. Improved Documentation * #335: Add new section “Converting versions between PyPI and semver” the limitations and possible use cases to convert from one into the other versioning scheme. * #340: Describe how to get version from a file * #343: Describe combining Pydantic with semver in the “Advanced topic” section. * #350: Restructure usage section. Create subdirectory “usage/” and splitted all section into different files. * #351: Introduce new topics for: * “Migration to semver3” * “Advanced topics” Features * PR #359: Add optional parameter optional_minor_and_patch in Version.parse() to allow optional minor and patch parts. * PR #362: Make Version.match() accept a bare version string as match expression, defaulting to equality testing. * #364: Enhance pyproject.toml to make it possible to use the pyproject-build command from the build module. For more information, see Building semver. * #365: Improve pyproject.toml. * Use setuptools, add metadata. Taken approach from A Practical Guide to Setuptools and Pyproject.toml. * Doc: Describe building of semver * Remove .travis.yml in MANIFEST.in (not needed anymore) * Distinguish between Python 3.6 and others in tox.ini * Add skip_missing_interpreters option for tox.ini * GH Action: Upgrade setuptools and setuptools-scm and test against 3.11.0-rc.2 Trivial/Internal Changes * #378: Fix some typos in Towncrier configuration
Version: 3.0.0-dev.3 Following issues/PRs were fixed for this release: Bug Fixes * #310: Rework API documentation. Follow a more “semi-manual” attempt and add auto directives into docs/api.rst. Improved Documentation * #312: Rework “Usage” section. * Mention the rename of VersionInfo to Version class * Remove `semver.` prefix in doctests to make examples shorter * Correct some references to dunder methods like `__getitem__()`, `__gt__()` etc. * Remove inconsistencies and mention module level function as deprecated and discouraged from using * Make empty `super()` call in `semverwithvprefix.py` example * #315: Improve release procedure text * #337: Improve documentation for semver max/min Trivial/Internal Changes * #309: Some (private) functions from the semver.version module has been changed. The following functions got renamed as it is only useful inside the Version class: * function `semver.version.comparator` got renamed to `semver.version._comparator()` * function `semver.version.cmp` got renamed to `semver.version._cmp()` The following functions got integrated into the Version class: * function `semver.version._nat_cmd` as a classmethod * function `semver.version.ensure_str` * #313: Correct `tox.ini` for changelog entry to skip installation for semver. This should speed up the execution of towncrier. * #316: Comparisons of Version class and other types return now a `NotImplemented` constant instead of a `TypeError` exception. The `NotImplemented` section of the Python documentation recommends returning this constant when comparing with `__gt__`, `__lt__`, and other comparison operators to “to indicate that the operation is not implemented with respect to the other type”. * #319: Introduce stages in `.travis.yml`. The config file contains now two stages: check and test. If check fails, the test stage won’t be executed. This could speed up things when some checks fails. * #322: Switch from Travis CI to GitHub Actions. * #347: Support Python 3.10 in GitHub Action and other config files. * Start supporting Python 3.10 Contributors (in alphabetical order) * @mzjp2 * @tlaferriere Thanks to all! ❤️
Version: 3.0.0-dev.2 Following issues/PRs were fixed for this release: # 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! ❤️
Version: 3.0.0-dev.1 This is a major release. So many things were changed. Following issues/PRs were fixed for this release: * #290: Create semver 3.0.0-dev.1; mostly improving in * documentation: new layout to distinguish from the semver2 line. Also new logo, removed occurances of Python2, describe changelog process with Towncrier and update release process. * Introduce `changelog.d` directory for Towncrier. Used to improve process of our Changelog generation. * Remove old code in regards to Python2; also testing it against 3.8, 3.9-dev, and 3.10-dev * #234: Simplify `setup.py` * #270: Configure Towncrier * #276: Document how to create a subclass from `VersionInfo` class * #291: Disallow negative numbers in `VersionInfo` arguments for `major`, `minor`, and `patch`.
PreviousNext