semver 3.0.2__tar.gz → 3.0.4__tar.gz

{semver-3.0.2 → semver-3.0.4}/.editorconfig

@@ -4,6 +4,7 @@ root = true
 [*]
 end_of_line = lf
 charset = utf-8
+max_line_length = 99
 
 [*.py]
 indent_style = space

{semver-3.0.2 → semver-3.0.4}/.gitignore

@@ -108,7 +108,7 @@ celerybeat.pid
 
 # Environments
 .env
-.venv
+.venv*
 env/
 venv/
 ENV/

semver-3.0.4/.pytest.ini

@@ -0,0 +1,15 @@
+[pytest]
+norecursedirs = .git build .env/ env/ .pyenv/ .tmp/ .eggs/ venv/
+testpaths = tests docs
+pythonpath = src tests
+filterwarnings =
+    ignore:Function 'semver.*:DeprecationWarning
+    # ' <- This apostroph is just to fix syntax highlighting
+addopts =
+    --import-mode=importlib
+    --no-cov-on-fail
+    --cov=semver
+    --cov-report=term-missing
+    --doctest-glob='*.rst'
+    --doctest-modules
+    --doctest-report ndiff

{semver-3.0.2 → semver-3.0.4}/.readthedocs.yaml

@@ -10,11 +10,17 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  jobs:
+    pre_install:
+      # - curl -LsSf https://astral.sh/uv/install.sh | sh
+      - pip install uv
+      - uv export --only-group docs --no-hashes --no-color > requirements-docs.txt
+    post_install:
+      - pip install -r requirements-docs.txt
+    pre_build:
+      - make -C docs html
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-python:
-  install:
-    - requirements: docs/requirements.txt

semver-3.0.4/.ruff.toml

@@ -0,0 +1,53 @@
+#
+# Configuration file for ruff
+# See https://docs.astral.sh/ruff/configuration/
+
+line-length = 88
+indent-width = 4
+include = [
+    "pyproject.toml",
+    "src/**/*.py",
+    "tests/**/*.py",
+    "docs/**/*.py",
+]
+
+[lint]
+extend-ignore = [
+    "RUF005",
+    "RUF012",
+    # Comment contains ambiguous `’` (RIGHT SINGLE QUOTATION MARK):
+    "RUF003",
+    "ISC001",
+]
+select = [
+    "F", # pyflakes
+    "E", # pycodestyle
+    "I", # isort
+    "N", # pep8-naming
+    "UP", # pyupgrade
+    "RUF", # ruff
+    "B", # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "ISC", # flake8-implicit-str-concat
+    "PTH", # flake8-use-pathlib
+    "SIM", # flake8-simplify
+    "TID", # flake8-tidy-imports
+]
+# TODO: Remove ISC001 ignore when formatter updated: https://github.com/astral-sh/ruff/issues/8272
+
+
+[format]
+# Exclude type hint stub files from formatting.
+exclude = ["*.pyi"]
+
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+docstring-code-format = true
+docstring-code-line-length = "dynamic"

{semver-3.0.2 → semver-3.0.4}/CHANGELOG.rst

@@ -18,11 +18,115 @@ This section covers the changes between major version 2 and version 3.
 
 .. towncrier release notes start
 
+Version 3.0.4
+=============
+
+:Released: 2025-01-24
+:Maintainer: Tom Schraitle
+
+
+Bug Fixes
+---------
+
+* :gh:`459`: Fix 3.0.3:
+
+  * :pr:`457`: Re-enable Trove license identifier
+  * :pr:`456`: Fix source dist file
+
+
+----
+
+
+Version 3.0.3
+=============
+
+:Released: 2025-01-18
+:Maintainer: Tom Schraitle
+
+
+Bug Fixes
+---------
+
+* :pr:`453`: The check in ``_comparator`` does not match the check in :meth:`Version.compare`. 
+  This breaks comparision with subclasses.
+
+
+
+Improved Documentation
+----------------------
+
+* :pr:`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 :file:`.readthedocs.yaml` file (commit ec9348a)
+  * Correct some smaller issues when building (commit f65feab)
+
+* :pr:`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.
+
+
+
+Features
+--------
+
+* :pr:`439`: Improve type hints to fix TODOs
+
+
+
+Internal Changes
+----------------
+
+* :pr:`440`: Update workflow file
+
+* :pr:`446`: Add Python 3.13 to GitHub Actions
+
+* :pr:`447`: Modernize project configs with :file:`pyproject.toml` and
+  use Astral's uv command.
+
+  * In :file:`pyproject.toml`:
+
+    * Move all project related data from :file:`setup.cfg` to :file:`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 (:file:`.ruff.toml`)
+  * Create config file for pytest (:file:`.pytest.ini`)
+  * Simplify :file:`tox.ini` and remove old stuff
+  * Document installation with new :command:`uv` command
+  * Simplify Sphinx config with :func:`find_version()`
+  * Update the authors
+  * Use :command:`uv` in GitHub Action :file:`python-testing.yml` workflow
+
+* Update :file:`release-procedure.md`.
+
+* :pr:`451`: Turn our Markdown issue templates into YAML
+
+
+Trivial Changes
+---------------
+
+* :pr:`438`: Replace organization placeholder in license
+
+* :pr:`445`: Improve private :func:`_nat_cmp` method:
+
+  * Remove obsolete else.
+  * Find a better way to identify digits without the :mod:`re` module.
+  * Fix docstring in :meth:`Version.compare`
+
+
+
+----
+
+
 Version 3.0.2
 =============
 
 :Released: 2023-10-09
-:Maintainer:
+:Maintainer: Tom Schraitle
 
 
 Bug Fixes

{semver-3.0.2 → semver-3.0.4}/LICENSE.txt

@@ -11,7 +11,7 @@ are permitted provided that the following conditions are met:
   list of conditions and the following disclaimer in the documentation and/or
   other materials provided with the distribution.
 
-  Neither the name of the {organization} nor the names of its
+  Neither the name of the python-semver org nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 

semver-3.0.4/MANIFEST.in

@@ -0,0 +1,26 @@
+include *.md
+include *.rst
+include *.txt
+include CONTRIBUTORS
+include CITATION.cff
+include Makefile
+include changelog.d/*
+graft docs/**
+include tests/*.py
+include tox.ini
+include .pytest.ini
+include .ruff.toml
+include uv.lock
+
+# The dot files:
+include .coveragerc
+include .editorconfig
+include .gitignore
+include .readthedocs.yaml
+
+
+prune docs/_build
+recursive-exclude .github  *
+prune docs/**/__pycache__
+
+global-exclude __pycache__

{semver-3.0.2 → semver-3.0.4}/PKG-INFO

@@ -1,22 +1,47 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: semver
-Version: 3.0.2
+Version: 3.0.4
 Summary: Python helper for Semantic Versioning (https://semver.org)
-Home-page: https://github.com/python-semver/python-semver
-Author: Kostiantyn Rybnikov
-Author-email: k-bx@k-bx.com
-Maintainer: Sebastien Celles, Tom Schraitle
-Maintainer-email: s.celles@gmail.com
-License: BSD
+Author-email: Kostiantyn Rybnikov <k-bx@k-bx.com>, Tom Schraitle <toms@suse.de>
+Maintainer-email: Tom Schraitle <toms@suse.de>, Sebastien Celles <s.celles@gmail.com>
+License: Copyright (c) 2013, Konstantine Rybnikov
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without modification,
+        are permitted provided that the following conditions are met:
+        
+          Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+          Redistributions in binary form must reproduce the above copyright notice, this
+          list of conditions and the following disclaimer in the documentation and/or
+          other materials provided with the distribution.
+        
+          Neither the name of the python-semver org nor the names of its
+          contributors may be used to endorse or promote products derived from
+          this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: GitHub Homepage, https://github.com/python-semver/python-semver
 Project-URL: Changelog, https://python-semver.readthedocs.io/en/latest/changelog.html
 Project-URL: Documentation, https://python-semver.rtfd.io
 Project-URL: Releases, https://github.com/python-semver/python-semver/releases
 Project-URL: Bug Tracker, https://github.com/python-semver/python-semver/issues
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
@@ -24,6 +49,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst

semver-3.0.4/changelog.d/459.bugfix.rst

@@ -0,0 +1,4 @@
+Fix 3.0.3:
+
+* :pr:`457`: Re-enable Trove license identifier
+* :pr:`456`: Fix source dist file

{semver-3.0.2 → semver-3.0.4}/docs/Makefile

@@ -8,6 +8,12 @@ SPHINXPROJ    = semver
 SOURCEDIR     = .
 BUILDDIR      = _build
 
+# Set the source directory for your project
+SRC_DIR       = ../src
+
+# Set the PYTHONPATH environment variable
+export PYTHONPATH := $(SRC_DIR):$(PYTHONPATH)
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

{semver-3.0.2 → semver-3.0.4}/docs/_static/css/custom.css

@@ -31,6 +31,10 @@ div.related.top nav {
     margin-bottom: -0.75em;
 }
 
+#searchbox {
+  margin-bottom: 1.25em;
+}
+
 .section h1 {
     font-weight: 700;
 }

semver-3.0.4/docs/_templates/layout.html

@@ -0,0 +1,10 @@
+{#
+  Import the theme's layout.
+#}
+{% extends "!layout.html" %}
+
+
+{%- block extrahead %}
+  {{- super() }}
+  <meta name="generator" content="Toms"/>
+{% endblock %}

{semver-3.0.2 → semver-3.0.4}/docs/advanced/combine-pydantic-and-semver.rst

@@ -1,6 +1,10 @@
 Combining Pydantic and semver
 =============================
 
+.. meta::
+   :description lang=en:
+      Combining Pydantic and semver
+
 According to its homepage, `Pydantic <https://pydantic-docs.helpmanual.io>`_
 "enforces type hints at runtime, and provides user friendly errors when data
 is invalid."

{semver-3.0.2 → semver-3.0.4}/docs/advanced/convert-pypi-to-semver.rst

@@ -1,6 +1,10 @@
-Converting versions between PyPI and semver
+Converting Versions between PyPI and semver
 ===========================================
 
+.. meta::
+   :description lang=en:
+      Converting versions between PyPI and semver
+
 .. Link
    https://packaging.pypa.io/en/latest/_modules/packaging/version.html#InvalidVersion
 

{semver-3.0.2 → semver-3.0.4}/docs/advanced/create-subclasses-from-version.rst

@@ -3,6 +3,10 @@
 Creating Subclasses from Version
 ================================
 
+.. meta::
+   :description lang=en:
+      Creating subclasses from Version class
+
 If you do not like creating functions to modify the behavior of semver
 (as shown in section :ref:`sec_dealing_with_invalid_versions`), you can
 also create a subclass of the :class:`Version <semver.version.Version>` class.

{semver-3.0.2 → semver-3.0.4}/docs/advanced/deal-with-invalid-versions.rst

@@ -3,6 +3,10 @@
 Dealing with Invalid Versions
 =============================
 
+.. meta::
+   :description lang=en:
+      Dealing with invalid versions
+
 As semver follows the semver specification, it cannot parse version
 strings which are considered "invalid" by that specification. The semver
 library cannot know all the possible variations so you need to help the

{semver-3.0.2 → semver-3.0.4}/docs/advanced/display-deprecation-warnings.rst

@@ -3,6 +3,10 @@
 Displaying Deprecation Warnings
 ===============================
 
+.. meta::
+   :description lang=en:
+      Displaying and filtering deprecation warnings
+
 By default,  deprecation warnings are `ignored in Python <https://docs.python.org/3/library/warnings.html#warning-categories>`_.
 This also affects semver's own warnings.
 

{semver-3.0.2 → semver-3.0.4}/docs/advanced/index.rst

@@ -1,6 +1,9 @@
 Advanced topics
 ===============
 
+.. meta::
+   :description lang=en:
+      Advanced topics for Python semver
 
 .. toctree::
     :maxdepth: 1

{semver-3.0.2 → semver-3.0.4}/docs/advanced/version-from-file.rst

@@ -1,8 +1,12 @@
 .. _sec_reading_versions_from_file:
 
-Reading versions from file
+Reading Versions from File
 ==========================
 
+.. meta::
+   :description lang=en:
+      Reading versions from file
+
 In cases where a version is stored inside a file, one possible solution
 is to use the following function:
 

{semver-3.0.2 → semver-3.0.4}/docs/api.rst

@@ -3,6 +3,10 @@
 API Reference
 =============
 
+.. meta::
+   :description lang=en:
+      API reference about Python semver
+
 .. currentmodule:: semver
 
 

semver-3.0.4/docs/build-semver.rst

@@ -0,0 +1,33 @@
+.. _build-semver:
+
+Building semver
+===============
+
+.. meta::
+   :description lang=en:
+      Building semver
+
+.. _Installing uv: https://docs.astral.sh/uv/getting-started/installation/
+
+
+This project changed its way how it is built over time. We used to have
+a :file:`setup.py` file, but switched to a :file:`pyproject.toml` setup.
+
+The build process is managed by :command:`uv` command.
+
+You need:
+
+* Python 3.7 or newer.
+
+* The :mod:`setuptools` module version 61 or newer which is used as
+  a build backend.
+
+* The command :command:`uv` from Astral. Refer to the section
+  `Installing uv`_  for more information.
+
+
+To build semver, run::
+
+    uv build
+
+After the command is finished, you can find two files in the :file:`dist` folder: a ``.tar.gz`` and a ``.whl`` file.

{semver-3.0.2 → semver-3.0.4}/docs/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # python-semver documentation build configuration file
 #
@@ -16,37 +15,31 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import codecs
-from datetime import date
+
 import os
 import re
-import sys
+from datetime import date
+from pathlib import Path
 
-SRC_DIR = os.path.abspath("../src/")
-sys.path.insert(0, SRC_DIR)
-# from semver import __version__  # noqa: E402
+SRC_DIR = Path(__file__).absolute().parent.parent / "src"
 YEAR = date.today().year
 
 
-def read(*parts):
-    """
-    Build an absolute path from *parts* and and return the contents of the
-    resulting file.  Assume UTF-8 encoding.
-    """
-    here = os.path.abspath(os.path.dirname(__file__))
-    with codecs.open(os.path.join(here, *parts), "rb", "utf-8") as f:
-        return f.read()
-
-
-def find_version(*file_paths):
+def find_version(path: Path) -> str:
     """
     Build a path from *file_paths* and search for a ``__version__``
     string inside.
     """
-    version_file = read(*file_paths)
-    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
+    content = Path(path).read_text(encoding="utf-8")
+
+    version_match = re.search(
+        r"^__version__ = ['\"]([^'\"]*)['\"]",
+        content,
+        re.MULTILINE
+    )
     if version_match:
         return version_match.group(1)
+
     raise RuntimeError("Unable to find version string.")
 
 
@@ -86,14 +79,14 @@ master_doc = "index"
 # General information about the project.
 project = "python-semver"
 copyright = f"{YEAR}, Kostiantyn Rybnikov and all"
-author = "Kostiantyn Rybnikov and all"
+author = "Kostiantyn Rybnikov, Tom Schraitle, Sebastien Celles, and others"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-release = find_version("../src/semver/__about__.py")
+release = find_version(SRC_DIR / "semver/__about__.py")
 # The full version, including alpha/beta/rc tags.
 version = release  # .rsplit(u".", 1)[0]
 
@@ -174,7 +167,7 @@ html_theme_options = {
     "github_button": True,
     #:
     "github_type": "star",
-    #: whether to apply a ‘Fork me on Github’ banner
+    #: whether to apply a "Fork me on Github" banner
     #: in the top right corner of the page:
     # "github_banner": True,
     #
@@ -211,6 +204,20 @@ html_theme_options = {
 html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 
+html_sidebars = {
+    "**": [
+        "about.html",  # theme_logo
+        # 'relations.html',  # prev and next
+        "searchbox.html",  # basic/searchbox.html
+        "navigation.html",  # TOC
+        # 'donate.html',
+    ]
+}
+
+# Canonical link relation
+if os.environ.get("READTHEDOCS_CANONICAL_URL"):
+    html_baseurl = f"{os.environ['READTHEDOCS_CANONICAL_URL']}"
+
 # html_logo = "logo.svg"
 
 # -- Options for HTMLHelp output ------------------------------------------

{semver-3.0.2 → semver-3.0.4}/docs/contribute/add-changelog-entry.rst

@@ -3,5 +3,9 @@
 Adding a Changelog Entry
 ========================
 
+.. meta::
+   :description lang=en:
+      Adding a changelog entry with Towncrier
+
 .. include:: ../../changelog.d/README.rst
     :start-after: -text-begin-

{semver-3.0.2 → semver-3.0.4}/docs/contribute/doc-semver.rst

@@ -3,6 +3,10 @@
 Documenting semver
 ==================
 
+.. meta::
+   :description lang=en:
+      Documenting semver with type annotations, docstrings, Sphinx directives
+
 Documenting the features of semver is very important. It gives our developers
 an overview what is possible with semver, how it "feels", and how it is
 used efficiently.

{semver-3.0.2 → semver-3.0.4}/docs/contribute/finish-release.rst

@@ -3,6 +3,10 @@
 Finish the Release
 ==================
 
+.. meta::
+   :description lang=en:
+      Finish the semver release by creating tags
+
 1. Create a tag:
 
    $ git tag -a x.x.x

{semver-3.0.2 → semver-3.0.4}/docs/contribute/index.rst

@@ -3,6 +3,10 @@
 Contributing to semver
 ======================
 
+.. meta::
+   :description lang=en:
+      Contributing to Python semver
+
 The semver source code is managed using Git and is hosted on GitHub::
 
    git clone git://github.com/python-semver/python-semver

{semver-3.0.2 → semver-3.0.4}/docs/contribute/prerequisites.rst

@@ -1,6 +1,10 @@
 Prerequisites
 -------------
 
+.. meta::
+   :description lang=en:
+      Overview of prerequisites for contributing
+
 .. -text-begin-
 
 Before you make changes to the code, we would highly appreciate if you

{semver-3.0.2 → semver-3.0.4}/docs/contribute/release-procedure.rst

@@ -1,6 +1,10 @@
 Release Procedure
 =================
 
+.. meta::
+   :description lang=en:
+      Release procedure: prepare and create the release
+
 The following procedures gives a short overview of what steps are needed
 to create a new release.