AutoGitSemVer 0.8.3__tar.gz → 0.9.0__tar.gz

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/.copier-answers.yml

@@ -6,7 +6,7 @@
 # available at https://github.com/gt-sse-center/copier-UvScaffolding.
 #
 
-_commit: v0.2.0
+_commit: v0.2.4
 _src_path: .
 author_email: github@DavidBrownell.com
 author_name: David Brownell

autogitsemver-0.9.0/.gitignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.coverage
+.DS_Store
+.vscode
+coverage.xml
+minisign_key.pri
+post_generation_instructions.html

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/DEVELOPMENT.md

@@ -19,7 +19,7 @@
 | Automated Testing | `uv run pytest` or<br/>`uv run pytest --no-cov` | Run automated tests using [pytest](https://docs.pytest.org/) and extract code coverage using [coverage](https://coverage.readthedocs.io/) based on settings in `pyproject.toml`. | :white_check_mark: | :white_check_mark: |
 | Semantic Version Generation | `uv run python -m AutoGitSemVer.scripts.UpdatePythonVersion ./src/AutoGitSemVer/__init__.py ./src` | Generate a new [Semantic Version](https://semver.org/) based on git commits using [AutoGitSemVer](https://github.com/davidbrownell/AutoGitSemVer). Version information is stored in `./src/AutoGitSemVer/__init__.py`. | | :white_check_mark: |
 | Python Package Creation | `uv build` | Create a python package using [uv](https://github.com/astral-sh/uv) based on settings in `pyproject.toml`. Generated packages will be written to `./dist`. | | :white_check_mark: |
-| Sign Artifacts | `uv run --with py-minisign python -c "import minisign; minisign.SecretKey.from_file(<temp_filename>).sign_file(<filename>, trusted_comment='<package_name> v<package_version>', drop_signature=True)` | Signs artifacts using [py-minisign](https://github.com/x13a/py-minisign). Note that the private key is stored as a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). | | :white_check_mark: |
+| Sign Artifacts | `uv run python -c "import minisign; minisign.SecretKey.from_file(<temp_filename>).sign_file(<filename>, trusted_comment='<package_name> v<package_version>', drop_signature=True)` | Signs artifacts using [py-minisign](https://github.com/x13a/py-minisign). Note that the private key is stored as a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). | | :white_check_mark: |
 | Python Package Publishing | `uv publish` | Publish a python package to [PyPi](https://pypi.org/) using [uv](https://github.com/astral-sh/uv) based on settings in `pyproject.toml`. | | :white_check_mark: |
 
 ## Contributing Changes

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoGitSemVer
-Version: 0.8.3
+Version: 0.9.0
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/davidbrownell/AutoGitSemVer
 Project-URL: Documentation, https://github.com/davidbrownell/AutoGitSemVer
@@ -260,11 +260,13 @@ A simple example of a configuration file can be found [here](https://github.com/
 | Via [pip](https://pip.pypa.io/en/stable/) | `pip install AutoGitSemVer` |
 
 ### Verifying Signed Artifacts
-Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+Artifacts are signed and verified using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
 
 To verify that an artifact is valid, visit [the latest release](https://github.com/davidbrownell/AutoGitSemVer/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
 
-`uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"`
+```shell
+uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>'); print('The file has been verified.')"
+```
 
 ## Development
 Please visit [Contributing](https://github.com/davidbrownell/AutoGitSemVer/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/AutoGitSemVer/blob/main/DEVELOPMENT.md) for information on contributing to this project.
@@ -282,4 +284,4 @@ Additional information can be found at these locations.
 | Security | [SECURITY.md](https://github.com/davidbrownell/AutoGitSemVer/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
 
 ## License
-AutoGitSemVer is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+`AutoGitSemVer` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/README.md

@@ -227,11 +227,13 @@ A simple example of a configuration file can be found [here](https://github.com/
 | Via [pip](https://pip.pypa.io/en/stable/) | `pip install AutoGitSemVer` |
 
 ### Verifying Signed Artifacts
-Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+Artifacts are signed and verified using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
 
 To verify that an artifact is valid, visit [the latest release](https://github.com/davidbrownell/AutoGitSemVer/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
 
-`uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"`
+```shell
+uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>'); print('The file has been verified.')"
+```
 
 ## Development
 Please visit [Contributing](https://github.com/davidbrownell/AutoGitSemVer/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/AutoGitSemVer/blob/main/DEVELOPMENT.md) for information on contributing to this project.
@@ -249,4 +251,4 @@ Additional information can be found at these locations.
 | Security | [SECURITY.md](https://github.com/davidbrownell/AutoGitSemVer/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
 
 ## License
-AutoGitSemVer is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+`AutoGitSemVer` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/pyproject.toml

@@ -13,6 +13,7 @@ dependencies = [
     "rtyaml>=1.0.0",
     "semantic-version>=2.10.0",
 ]
+
 dynamic = ["version"]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -52,16 +53,17 @@ build-backend = "hatchling.build"
 dev = [
     "dbrownell-commitemojis>=0.1.1",
     "pre-commit>=4.2.0",
-    "pytest>=8.3.5",
-    "pytest-cov>=6.1.1",
-    "ruff>=0.11.9",
+    "py-minisign>=0.12.0",
+    "pytest>=8.4.1",
+    "pytest-cov>=6.2.1",
+    "ruff>=0.12.3",
 ]
 
 [tool.hatch.version]
 path = "src/AutoGitSemVer/__init__.py"
 
 [tool.pytest.ini_options]
-addopts = "--verbose -vv --capture=no --cov=AutoGitSemVer --cov-fail-under=90.0"
+addopts = "--verbose -vv --capture=no --cov=AutoGitSemVer --cov-report term --cov-report xml:coverage.xml --cov-fail-under=90.0"
 python_files = [
     "**/*Test.py",
 ]
@@ -77,12 +79,21 @@ ignore = [
     "ANN003", # Missing type annotation for `**kwargs`
     "BLE001", # Do not catch blind exception: `Exception`
     "COM812", # Trailing comma missing
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in `__init__` method
     "D202", # No blank lines allowed after function docstring
     "E501", # Line too long
+    "FIX002", # Line contains TODO, consider resolving the issue
     "I001", # Import block is un-sorted or un-formatted
     "N802", # Function name `xxx` should be lowercase
     "N999", # Invalid module name
+    "RSE102", # Unnecessary parentheses on raise exception
     "S101", # Use of assert detected
+    "TC006", # Add quotes to type expression in `typing.cast()`
+    "TD002", # Missing author in TODO
+    "TD003", # Missing issue link for this TODO
+    "TRY002", # Create your own exception
+    "TRY300", # Consider moving this statement to an `else` block
     "UP032", # Use f-string instead of `format` call
 ]
 

autogitsemver-0.9.0/src/AutoGitSemVer/__init__.py

@@ -0,0 +1,17 @@
+# noqa: D104
+
+# Wheel names will be generated according to this value. Do not manually modify this value; instead
+# update it according to committed changes by running this command from the root of the repository:
+#
+#   uv run python -m AutoGitSemVer.scripts.UpdatePythonVersion ./src/AutoGitSemVer/__init__.py ./src
+#
+__version__ = "0.9.0"
+
+
+from .Lib import GenerateStyle, GetSemanticVersion, GetSemanticVersionResult
+
+__all__ = [
+    "GenerateStyle",
+    "GetSemanticVersion",
+    "GetSemanticVersionResult",
+]

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/src/AutoGitSemVer/scripts/UpdatePythonVersion.py

@@ -46,13 +46,13 @@ app = typer.Typer(
 # ----------------------------------------------------------------------
 @app.command("EntryPoint", help=__doc__, no_args_is_help=True)
 def EntryPoint(
-    python_filename: Annotated[
+    filename: Annotated[
         Path,
         typer.Argument(
             dir_okay=False,
             exists=True,
             resolve_path=True,
-            help="Name of the python file that contains the __version__ variable.",
+            help="Name of the python file that contains the __version__ variable or the pyproject.toml file that contains the version variable.",
         ),
     ],
     working_dir: Annotated[
@@ -76,7 +76,7 @@ def EntryPoint(
     with DoneManager.CreateCommandLine(
         flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
     ) as dm:
-        working_dir = working_dir or python_filename.parent
+        working_dir = working_dir or filename.parent
 
         version = GetSemanticVersion(
             dm,
@@ -89,17 +89,31 @@ def EntryPoint(
 
         dm.WriteLine("")
 
-        with dm.Nested(f"Updating '{python_filename}'...") as update_dm:
-            with python_filename.open(encoding="utf-8") as f:
+        with dm.Nested(f"Updating '{filename}'...") as update_dm:
+            with filename.open(encoding="utf-8") as f:
                 content = f.read()
 
-            match = re.search(
-                r"^(?P<prefix>\s*__version__\s*=\s*)(?P<quote>['\"])\S*?(?P=quote)(?P<newline>\r?\n)",
-                content,
-                flags=re.MULTILINE,
-            )
+            if filename.suffix == ".py":
+                variable_name = "__version__"
+
+                regex = re.compile(
+                    rf"^(?P<prefix>\s*{variable_name}\s*=\s*)(?P<quote>['\"])\S*?(?P=quote)(?P<newline>\r?\n)",
+                    flags=re.MULTILINE,
+                )
+            elif filename.suffix == ".toml":
+                variable_name = "version"
+
+                regex = re.compile(
+                    rf"^(?P<prefix>{variable_name}\s*=\s*)(?P<quote>['\"])\S*?(?P=quote)(?P<newline>\r?\n)",
+                    flags=re.MULTILINE,
+                )
+            else:
+                error = f"'{filename}' is not a recognized file type."
+                raise Exception(error)
+
+            match = regex.search(content)
             if not match:
-                update_dm.WriteError("A '__version__' variable was not found.\n")
+                update_dm.WriteError(f"A '{variable_name}' variable was not found.\n")
                 return
 
             content = "".join(
@@ -114,7 +128,7 @@ def EntryPoint(
                 ],
             )
 
-            with python_filename.open("w", encoding="utf-8", newline=match.group("newline")) as f:
+            with filename.open("w", encoding="utf-8", newline=match.group("newline")) as f:
                 f.write(content)
 
 
@@ -122,4 +136,4 @@ def EntryPoint(
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 if __name__ == "__main__":
-    app()
+    app()  # pragma: no cover

{autogitsemver-0.8.3 → autogitsemver-0.9.0}/tests/scripts/UpdatePythonVersion_UnitTest.py

@@ -18,15 +18,14 @@ import textwrap
 from pathlib import Path
 from unittest.mock import MagicMock as Mock, mock_open, patch
 
-import pytest
-
+from click.testing import Result
 from typer.testing import CliRunner
 from AutoGitSemVer import GetSemanticVersionResult
 from AutoGitSemVer.scripts.UpdatePythonVersion import app
 
 
 # ----------------------------------------------------------------------
-def test_Default():
+def test_Python():
     _Execute(
         textwrap.dedent(
             """\
@@ -46,7 +45,7 @@ def test_Default():
 
 
 # ----------------------------------------------------------------------
-def test_NoVersion():
+def test_NoPythonVersion():
     _Execute(
         textwrap.dedent(
             """\
@@ -58,6 +57,53 @@ def test_NoVersion():
     )
 
 
+# ----------------------------------------------------------------------
+def test_Toml():
+    _Execute(
+        textwrap.dedent(
+            """\
+            # Line Before
+            version = ""
+            # Line After
+            """,
+        ),
+        textwrap.dedent(
+            """\
+            # Line Before
+            version = "1.2.3"
+            # Line After
+            """,
+        ),
+        file_extension=".toml",
+    )
+
+
+# ----------------------------------------------------------------------
+def test_NoTomlVersion():
+    _Execute(
+        textwrap.dedent(
+            """\
+            # No version in this file
+            """,
+        ),
+        "",
+        file_extension=".toml",
+        expected_failure=True,
+    )
+
+
+# ----------------------------------------------------------------------
+def test_UnsupportedFileType():
+    result = _Execute(
+        "",
+        "",
+        file_extension=".md",
+        expected_failure=True,
+    )
+    exception_message = str(result.exception)
+    assert "README.md' is not a recognized file type." in exception_message
+
+
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
@@ -65,8 +111,9 @@ def _Execute(
     original: str,
     expected: str,
     *,
+    file_extension: str = ".py",
     expected_failure: bool = False,
-) -> str:
+) -> Result:
     # ----------------------------------------------------------------------
     def MyWrite(value):
         assert value == expected
@@ -86,11 +133,20 @@ def _Execute(
         ),
         patch.object(Path, "open", file_mock),
     ):
-        result = CliRunner().invoke(app, [__file__])
+        if file_extension == ".py":
+            placeholder_filename = Path(__file__)
+        elif file_extension == ".toml":
+            placeholder_filename = Path(__file__).parent.parent.parent / "pyproject.toml"
+        elif file_extension == ".md":
+            placeholder_filename = Path(__file__).parent.parent.parent / "README.md"
+        else:
+            assert False, file_extension
+
+        result = CliRunner().invoke(app, [str(placeholder_filename)])
 
         if expected_failure:
-            assert result.exit_code != 0
+            assert result.exit_code != 0, result.output
         else:
-            assert result.exit_code == 0
+            assert result.exit_code == 0, result.output
 
-        return result.output
+        return result