AutoGitSemVer 0.8.2__tar.gz → 0.8.4__tar.gz

{autogitsemver-0.8.2 → autogitsemver-0.8.4}/.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.8.4/.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.2 → autogitsemver-0.8.4}/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.2 → autogitsemver-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: AutoGitSemVer
-Version: 0.8.2
+Version: 0.8.4
 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.2 → autogitsemver-0.8.4}/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.2 → autogitsemver-0.8.4}/pyproject.toml

@@ -13,6 +13,7 @@ dependencies = [
     "rtyaml>=1.0.0",
     "semantic-version>=2.10.0",
 ]
+
 dynamic = ["version"]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -40,6 +41,10 @@ Homepage = "https://github.com/davidbrownell/AutoGitSemVer"
 Documentation = "https://github.com/davidbrownell/AutoGitSemVer"
 Repository = "https://github.com/davidbrownell/AutoGitSemVer"
 
+[project.scripts]
+AutoGitSemVer = "AutoGitSemVer:EntryPoint.app"
+autogitsemver = "AutoGitSemVer:EntryPoint.app"
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -48,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",
 ]
@@ -73,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.8.4/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.8.4"
+
+
+from .Lib import GenerateStyle, GetSemanticVersion, GetSemanticVersionResult
+
+__all__ = [
+    "GenerateStyle",
+    "GetSemanticVersion",
+    "GetSemanticVersionResult",
+]