uv-lock-report 0.12.1__py3-none-any.whl

uv_lock_report/tests/test_lockfile_changes.py

@@ -0,0 +1,71 @@
+from uv_lock_report.models import LockfileChanges, OutputFormat, RequiresPythonChanges
+
+from .conftest import (
+    ADDED_PACKAGES,
+    EXPECTED_LOCKFILE_CHANGES_FULL_MODEL_DUMP_SIMPLE,
+    EXPECTED_LOCKFILE_CHANGES_FULL_MODEL_DUMP_SIMPLE_WITH_LINK,
+    EXPECTED_LOCKFILE_CHANGES_FULL_MODEL_DUMP_TABLE,
+    EXPECTED_LOCKFILE_CHANGES_FULL_SIMPLE,
+    EXPECTED_LOCKFILE_CHANGES_FULL_SIMPLE_WITH_LINK,
+    EXPECTED_LOCKFILE_CHANGES_FULL_TABLE,
+    REMOVED_PACKAGES,
+    UPDATED_PACKAGES,
+)
+
+
+class TestLockfileChanges:
+    def test_empty_markdown(self):
+        lfc = LockfileChanges(
+            requires_python=RequiresPythonChanges(old=None, new=None),
+            output_format=OutputFormat.TABLE,
+            show_learn_more_link=False,
+        )
+        assert lfc.markdown == "## uv Lockfile Report"
+
+    def test_full_markdown_table(self):
+        lfc = LockfileChanges(
+            requires_python=RequiresPythonChanges(old=None, new=None),
+            added=ADDED_PACKAGES,
+            updated=UPDATED_PACKAGES,
+            removed=REMOVED_PACKAGES,
+            output_format=OutputFormat.TABLE,
+            show_learn_more_link=False,
+        )
+        assert lfc.markdown == EXPECTED_LOCKFILE_CHANGES_FULL_TABLE
+        assert lfc.items == len(ADDED_PACKAGES) + len(UPDATED_PACKAGES) + len(
+            REMOVED_PACKAGES
+        )
+        assert lfc.model_dump() == EXPECTED_LOCKFILE_CHANGES_FULL_MODEL_DUMP_TABLE
+
+    def test_full_markdown_simple(self):
+        lfc = LockfileChanges(
+            requires_python=RequiresPythonChanges(old=None, new=None),
+            added=ADDED_PACKAGES,
+            updated=UPDATED_PACKAGES,
+            removed=REMOVED_PACKAGES,
+            output_format=OutputFormat.SIMPLE,
+            show_learn_more_link=False,
+        )
+        assert lfc.markdown == EXPECTED_LOCKFILE_CHANGES_FULL_SIMPLE
+        assert lfc.items == len(ADDED_PACKAGES) + len(UPDATED_PACKAGES) + len(
+            REMOVED_PACKAGES
+        )
+        assert lfc.model_dump() == EXPECTED_LOCKFILE_CHANGES_FULL_MODEL_DUMP_SIMPLE
+
+    def test_full_markdown_simple_with_learn_more_link(self):
+        lfc = LockfileChanges(
+            requires_python=RequiresPythonChanges(old=None, new=None),
+            added=ADDED_PACKAGES,
+            updated=UPDATED_PACKAGES,
+            removed=REMOVED_PACKAGES,
+            output_format=OutputFormat.SIMPLE,
+            show_learn_more_link=True,
+        )
+        assert lfc.markdown == EXPECTED_LOCKFILE_CHANGES_FULL_SIMPLE_WITH_LINK
+        assert lfc.items == len(ADDED_PACKAGES) + len(UPDATED_PACKAGES) + len(
+            REMOVED_PACKAGES
+        )
+        assert (
+            lfc.model_dump()
+            == EXPECTED_LOCKFILE_CHANGES_FULL_MODEL_DUMP_SIMPLE_WITH_LINK
+        )

uv_lock_report/tests/test_updated_package.py

@@ -0,0 +1,11 @@
+from uv_lock_report.models import UpdatedPackage
+
+
+class TestUpdatedPackage:
+    def test_valid_versions(self):
+        up = UpdatedPackage(name="steve", old_version="1.0.0", new_version="2.0.0")
+        assert up.model_dump() == {
+            "name": "steve",
+            "new_version": "2.0.0",
+            "old_version": "1.0.0",
+        }

uv_lock_report/tests/test_version_change_level.py

@@ -0,0 +1,52 @@
+import pytest
+
+from uv_lock_report.models import VersionChangeLevel
+
+
+class TestVersionChangeLevel:
+    """Test the VersionChangeLevel enum and its gitmoji property."""
+
+    def test_major_gitmoji(self):
+        """Test that MAJOR change level returns collision emoji."""
+        assert VersionChangeLevel.MAJOR.gitmoji == ":collision:"
+
+    def test_minor_gitmoji(self):
+        """Test that MINOR change level returns sparkles emoji."""
+        assert VersionChangeLevel.MINOR.gitmoji == ":sparkles:"
+
+    def test_patch_gitmoji(self):
+        """Test that PATCH change level returns hammer and wrench emoji."""
+        assert VersionChangeLevel.PATCH.gitmoji == ":hammer_and_wrench:"
+
+    def test_unknown_gitmoji(self):
+        """Test that UNKNOWN change level returns question mark emoji."""
+        assert VersionChangeLevel.UNKNOWN.gitmoji == ":question:"
+
+    def test_all_levels_have_gitmoji(self):
+        """Test that all VersionChangeLevel values have a gitmoji defined."""
+        for level in VersionChangeLevel:
+            # Should not raise NotImplementedError
+            emoji = level.gitmoji
+            assert isinstance(emoji, str)
+            assert emoji.startswith(":")
+            assert emoji.endswith(":")
+
+    def test_level_values(self):
+        """Test that VersionChangeLevel enum values are correctly ordered."""
+        assert VersionChangeLevel.MAJOR == 0
+        assert VersionChangeLevel.MINOR == 1
+        assert VersionChangeLevel.PATCH == 2
+        assert VersionChangeLevel.UNKNOWN == 10
+
+    @pytest.mark.parametrize(
+        "level,expected_emoji",
+        [
+            (VersionChangeLevel.MAJOR, ":collision:"),
+            (VersionChangeLevel.MINOR, ":sparkles:"),
+            (VersionChangeLevel.PATCH, ":hammer_and_wrench:"),
+            (VersionChangeLevel.UNKNOWN, ":question:"),
+        ],
+    )
+    def test_gitmoji_mapping(self, level, expected_emoji):
+        """Parametrized test for all VersionChangeLevel to gitmoji mappings."""
+        assert level.gitmoji == expected_emoji

uv_lock_report-0.12.1.dist-info/METADATA

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: uv-lock-report
+Version: 0.12.1
+Summary: Parse and report package changes in uv.lock.
+Project-URL: Homepage, https://github.com/mw-root/uv-lock-report
+Project-URL: Source, https://github.com/mw-root/uv-lock-report
+Requires-Python: >=3.13
+Requires-Dist: packaging>=25.0
+Requires-Dist: pydantic>=2.11.9
+Description-Content-Type: text/markdown
+
+## uv Lock Report
+
+[![codecov](https://codecov.io/gh/mw-root/uv-lock-report/graph/badge.svg?token=QQFK62PQ8G)](https://codecov.io/gh/mw-root/uv-lock-report)
+
+## Description
+
+<!-- AUTO-DOC-DESCRIPTION:START - Do not remove or modify this section -->
+
+Digests complex `uv.lock` diffs in Pull Requests and provides a
+simple summary of dependency changes as a PR comment.
+
+<!-- AUTO-DOC-DESCRIPTION:END -->
+
+Pull Requests with lockfile changes can be difficult to evaluate at a quick glance
+and diffs are usually hidden by default.
+
+This GitHub Action transforms complex `uv.lock` diffs into a clean, easy-to-read report.
+It analyzes the changes between your base and head lockfiles, then posts a formatted comment showing exactly which packages were added, updated, or removed—including version changes and their severity (major, minor, or patch).
+
+No more parsing through hundreds of lines of TOML diffs to understand what changed.
+
+
+## Example Gitlab Actions Usage
+
+```yaml
+name: uv Lockfile Report
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Report
+        uses: mw-root/uv-lock-report@v0.7.0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Inputs
+
+<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
+
+|        INPUT         |  TYPE  | REQUIRED |  DEFAULT   |                           DESCRIPTION                           |
+|----------------------|--------|----------|------------|-----------------------------------------------------------------|
+|     github-token     | string |   true   |            |                          GitHub Token                           |
+|    output-format     | string |  false   | `"simple"` |   The output format of the report. <br>One of: simple, table    |
+| show-learn-more-link | string |  false   |  `"true"`  | Whether to show a "Learn More" <br>link in the report comment.  |
+
+<!-- AUTO-DOC-INPUT:END -->
+
+
+
+### Output Format Examples
+
+The formatting can be chosen with the `output-format` input.
+
+#### Simple Format ( Default )
+![Example Comment](images/uv-lock-report-simple-comment.png "Simple Format")
+
+
+#### Table Format
+![Example Comment](images/uv-lock-report-table-comment.png "Table Format")
+
+## CLI Usage
+
+You can also use `uv-lock-report` as a standalone CLI tool for local development or in custom CI/CD pipelines.
+
+### Installation
+
+Install the package using uv:
+
+```bash
+uv build
+pip install ./dist/uv_lock_report-0.1.0-py3-none-any.whl
+```
+
+### Usage
+
+```bash
+uv-lock-report --base-sha <git-sha> --base-path <path-to-base-lockfile> --output-path <output-file>
+```
+
+#### Arguments
+
+- `--base-sha`: Git SHA of the base commit to compare against
+- `--base-path`: Path to the base lockfile (usually `uv.lock`)
+- `--output-path`: Path where the JSON report will be written
+- `--output-format`: Output format (`table` or `simple`, default: `table`)
+- `--show-learn-more-link`: Whether to show "Learn More" link (`true` or `false`, default: `true`)
+
+#### Example
+
+```bash
+# Compare current uv.lock with the one from main branch
+uv-lock-report \
+  --base-sha main \
+  --base-path uv.lock \
+  --output-path report.json \
+  --output-format table
+```
+
+### Testing the installation
+
+You can test that the CLI is properly installed:
+
+```bash
+# Test with a built wheel
+uv run --with ./dist/uv_lock_report-0.1.0-py3-none-any.whl uv-lock-report --help
+
+# Or run the included test script
+uv run python test_cli_install.py
+```

uv_lock_report-0.12.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+uv_lock_report/__init__.py,sha256=zKtnG7mL7xg1KILo66OgUMSbTVASEQziETf1boXqleY,653
+uv_lock_report/__main__.py,sha256=TRR4lhwzvfRgbC7NgkLK3w8c9cxiBJrgIUpwZ7NszPM,211
+uv_lock_report/cli.py,sha256=D0VdCQoa6Lu5PNHrlAQEFFH5-nHVkr3EZbm_UqrKWC8,1188
+uv_lock_report/models.py,sha256=gsKUKaTNLuCW7jO4LAqRcefxVvU8iFBnAiI4smWXJHQ,13208
+uv_lock_report/report.py,sha256=UtaMSpTB0Lx0imaT30Iu45fJYZdS9gDO7s8VXcSAow0,1779
+uv_lock_report/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+uv_lock_report/tests/conftest.py,sha256=JlHtpwzC4fSeEU9flBjmuSRmztWa92symBmvTiiadNg,4267
+uv_lock_report/tests/test_get_lockfiles.py,sha256=T0vMVhm3fey3BRUw4tPOnRKsakRFw9xM28a9bvfkyuA,12043
+uv_lock_report/tests/test_lock_file_reporter.py,sha256=v2eMQJSHDkS19OClEpwPcZlT1zQxtRntQo90gtGhfhQ,22846
+uv_lock_report/tests/test_lockfile.py,sha256=yyoKh7XsgSSPriO2-LSHt3J04zOJd6fGKZNQbboNgrg,1372
+uv_lock_report/tests/test_lockfile_changes.py,sha256=8lHcHGGNkFwzk5MKATBFRZPjb0CfMJvkUujGYuFIsWk,2742
+uv_lock_report/tests/test_updated_package.py,sha256=YXqPdE7rgj71IEl35iWwoPCEse0a8STn5bO1t4-EAT4,343
+uv_lock_report/tests/test_version_change_level.py,sha256=x5mhdMTb7fLqtw-6Bz_0tgatefE7jTo3DitCsXUUnqY,2034
+uv_lock_report-0.12.1.dist-info/METADATA,sha256=FwSEZbaplW752PXC-ptU9sh5WTbnCOoXLyiJ5RcXOs0,3958
+uv_lock_report-0.12.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uv_lock_report-0.12.1.dist-info/entry_points.txt,sha256=li0cGnt4Tj1WfCUcoycxuq-AGJNsYy6GXUM-anRvf30,59
+uv_lock_report-0.12.1.dist-info/RECORD,,

uv_lock_report-0.12.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

uv_lock_report-0.12.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+uv-lock-report = uv_lock_report.cli:main