rename sbom-diff to spdx-diff

Signed-off-by: Benjamin Robin (Schneider Electric) <benjamin.robin@bootlin.com>

Author: benjarobin

.github/workflows/test.yaml

@@ -15,11 +15,11 @@ jobs:
           - "3.14"
     steps:
       - uses: actions/checkout@v5
-      - name: Checkout meta-sbom-diff-test for tests
+      - name: Checkout meta-spdx-diff-test for tests
         uses: actions/checkout@v5
         with:
-          repository: bootlin/meta-sbom-diff-test
-          path: meta-sbom-diff-test
+          repository: bootlin/meta-spdx-diff-test
+          path: meta-spdx-diff-test
       - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -39,7 +39,7 @@ jobs:
           pip install --group test
       - name: Run tests
         env:
-          SBOM_DIFF_SBOM_DATA: ${{ github.workspace }}/meta-sbom-diff-test/sbom-data
+          SPDX_DIFF_SBOM_DATA: ${{ github.workspace }}/meta-spdx-diff-test/sbom-data
         working-directory: tests
         run: |
           pytest -v

.gitignore

@@ -54,9 +54,3 @@ env/
 *.swp
 *.swo
 *~
-
-# sbom-diff specific
-spdx_diff_*.json
-
-# Old script (if exists)
-sbom-diff

CHANGELOG.md

@@ -15,7 +15,7 @@ All notable changes to this project will be documented in this file.
 ## [1.0.0] - 2026-02-12
 
 ### Added
-- Initial stable release of sbom-diff
+- Initial stable release of spdx-diff
 ---
 
 ## Release Information
@@ -25,10 +25,10 @@ All notable changes to this project will be documented in this file.
 - **Status:** Stable
 - **Breaking Changes:** None (initial release)
 
-This is the first stable release of sbom-diff.
+This is the first stable release of spdx-diff.
 
 ---
 
 <!-- Links -->
-[unreleased]: https://github.com/bootlin/sbom-diff/compare/v1.0.0...HEAD
-[1.0.0]: https://github.com/bootlin/sbom-diff/releases/tag/v1.0.0
+[unreleased]: https://github.com/bootlin/spdx-diff/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/bootlin/spdx-diff/releases/tag/v1.0.0

INSTALL.md

@@ -3,7 +3,7 @@
 ## Method 1: Quick Install (System-wide)
 
 ```bash
-cd sbom-diff
+cd spdx-diff
 pip install . --break-system-packages
 ```
 
@@ -14,7 +14,7 @@ pip install . --break-system-packages
 ## Method 2: Virtual Environment (Recommended)
 
 ```bash
-cd sbom-diff
+cd spdx-diff
 
 # Create virtual environment
 python3 -m venv .venv
@@ -26,7 +26,7 @@ source .venv/bin/activate
 pip install -e .
 
 # Use the tool
-sbom-diff --help
+spdx-diff --help
 
 # When done
 deactivate
@@ -44,16 +44,16 @@ After installation:
 
 ```bash
 # Show help
-sbom-diff --help
+spdx-diff --help
 
 # Compare two SPDX files
-sbom-diff reference.json new.json
+spdx-diff reference.json new.json
 
 # Show summary only
-sbom-diff reference.json new.json --summary
+spdx-diff reference.json new.json --summary
 
 # JSON output for automation
-sbom-diff reference.json new.json --format json --output results.json
+spdx-diff reference.json new.json --format json --output results.json
 ```
 
 See `README.md` for full documentation.
@@ -64,13 +64,13 @@ See `README.md` for full documentation.
 
 **System-wide:**
 ```bash
-pip uninstall sbom-diff
+pip uninstall spdx-diff
 ```
 
 **Virtual environment:**
 ```bash
 source .venv/bin/activate
-pip uninstall sbom-diff
+pip uninstall spdx-diff
 deactivate
 ```
 

README.md

@@ -13,7 +13,7 @@ It produces both human-readable output (console) and a structured JSON diff file
 Usage
 -----
 ```bash
-./sbom-diff reference.json new.json [OPTIONS]
+./spdx-diff reference.json new.json [OPTIONS]
 ```
 
 Required arguments:
@@ -72,7 +72,7 @@ Summary Mode
 When using --summary, the tool displays aggregate statistics:
 
 ```
-SPDX-SBOM-Diff Summary:
+SPDX-Diff Summary:
 
 Packages:
   Added:   5
@@ -158,34 +158,34 @@ Examples
 --------
 
 ### Basic comparison with both console and JSON output:
-    ./sbom-diff reference.json new.json
+    ./spdx-diff reference.json new.json
 
 ### Full details with proprietary packages excluded:
-    ./sbom-diff reference.json new.json --ignore-proprietary --full
+    ./spdx-diff reference.json new.json --ignore-proprietary --full
 
 ### Quick summary check:
-    ./sbom-diff reference.json new.json --summary
+    ./spdx-diff reference.json new.json --summary
 
 ### Silent mode for CI/CD (JSON output only):
-    ./sbom-diff reference.json new.json --format json --output results.json
+    ./spdx-diff reference.json new.json --format json --output results.json
 
 ### Console output only (no JSON file):
-    ./sbom-diff reference.json new.json --format text --full
+    ./spdx-diff reference.json new.json --format text --full
 
 ### Show only changed packages:
-    ./sbom-diff reference.json new.json --show-packages --show-changed
+    ./spdx-diff reference.json new.json --show-packages --show-changed
 
 ### Show only added packages:
-    ./sbom-diff reference.json new.json --show-packages --show-added
+    ./spdx-diff reference.json new.json --show-packages --show-added
 
 ### Show only kernel config changes:
-    ./sbom-diff reference.json new.json --show-config --show-changed
+    ./spdx-diff reference.json new.json --show-config --show-changed
 
 ### Show added and changed items across all categories:
-    ./sbom-diff reference.json new.json --show-added --show-changed
+    ./spdx-diff reference.json new.json --show-added --show-changed
 
 ### Show only PACKAGECONFIG differences:
-    ./sbom-diff reference.json new.json --show-packageconfig
+    ./spdx-diff reference.json new.json --show-packageconfig
 
 Console output example:
 ```

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "sbom-diff"
+name = "spdx-diff"
 dynamic = ["version"]
 description = "SPDX3 SBOM comparison tool for packages, kernel config, and PACKAGECONFIG"
 readme = "README.md"
@@ -22,13 +22,13 @@ classifiers = [
 ]
 
 [project.scripts]
-sbom-diff = "sbom_diff.cli:main"
+spdx-diff = "spdx_diff.cli:main"
 
 [project.urls]
-Repository = "https://github.com/bootlin/sbom-diff"
-Documentation = "https://github.com/bootlin/sbom-diff/blob/main/README.md"
-"Bug Tracker" = "https://github.com/bootlin/sbom-diff/issues"
-Changelog = "https://github.com/bootlin/sbom-diff/blob/main/CHANGELOG.md"
+Repository = "https://github.com/bootlin/spdx-diff"
+Documentation = "https://github.com/bootlin/spdx-diff/blob/main/README.md"
+"Bug Tracker" = "https://github.com/bootlin/spdx-diff/issues"
+Changelog = "https://github.com/bootlin/spdx-diff/blob/main/CHANGELOG.md"
 
 [dependency-groups]
 test = [
@@ -45,11 +45,11 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.hatch.version]
-path = "src/sbom_diff/__init__.py"
+path = "src/spdx_diff/__init__.py"
 
 [tool.hatch.build.targets.wheel]
 only-packages = true
-packages = ["src/sbom_diff"]
+packages = ["src/spdx_diff"]
 
 [tool.ruff]
 line-length = 88

src/sbom_diff/__init__.py src/spdx_diff/__init__.pysrc/sbom_diff/__init__.py renamed to src/spdx_diff/__init__.py

@@ -379,7 +379,7 @@ def print_summary(
         pcfg_diff: PACKAGECONFIG differences
 
     """
-    print("\nSPDX-SBOM-Diff Summary:\n")
+    print("\nSPDX-Diff Summary:\n")
 
     print("Packages:")
     print(f"  Added:   {len(pkg_diff[0])}")
@@ -468,7 +468,7 @@ def main() -> None:
     """
     parser = ArgumentParser(description="Compare SPDX3 JSON files")
     parser.add_argument(
-        "--version", action="version", version=f"sbom-diff {__version__}"
+        "--version", action="version", version=f"spdx-diff {__version__}"
     )
     parser.add_argument(
         "-v",

src/sbom_diff/cli.py src/spdx_diff/cli.pysrc/sbom_diff/cli.py renamed to src/spdx_diff/cli.py

@@ -2,7 +2,6 @@
 
 import os
 import pathlib
-import subprocess
 import tempfile
 from collections.abc import Generator
 from typing import Any
@@ -12,15 +11,15 @@
 
 @pytest.fixture(scope="session")
 def sbom_data() -> Generator[pathlib.Path, None, None]:
-    if path := os.environ.get("SBOM_DIFF_SBOM_DATA"):
+    if path := os.environ.get("SPDX_DIFF_SBOM_DATA"):
         sbom_data_path = pathlib.Path(path).resolve()
         if sbom_data_path.is_dir():
             yield sbom_data_path
             return
 
     sbom_data_path = (
         pathlib.Path(__file__)
-        .parent.parent.parent.joinpath("meta-sbom-diff-test", "sbom-data")
+        .parent.parent.parent.joinpath("meta-spdx-diff-test", "sbom-data")
         .resolve()
     )
     if sbom_data_path.is_dir():
@@ -30,20 +29,20 @@ def sbom_data() -> Generator[pathlib.Path, None, None]:
     pytest.exit(
         "The `sbom-data` directory was not found. To resolve this issue, "
         "please do one of the following: \n"
-        " - Clone https://github.com/bootlin/meta-sbom-diff-test.git repository at the"
-        " same directory level as the `sbom-diff` repository.\n"
-        " - Set the `SBOM_DIFF_SBOM_DATA` environment variable to the path of"
-        " `sbom-data` directory, contained in the `meta-sbom-diff-test` repository.",
+        " - Clone https://github.com/bootlin/meta-spdx-diff-test.git repository at the"
+        " same directory level as the `spdx-diff` repository.\n"
+        " - Set the `SPDX_DIFF_SBOM_DATA` environment variable to the path of"
+        " `sbom-data` directory, contained in the `meta-spdx-diff-test` repository.",
         returncode=1,
     )
 
 
 @pytest.fixture(scope="function")
 def tmp_dir() -> Generator[pathlib.Path, None, None]:
     extra_opts: dict[str, Any] = {}
-    if os.environ.get("SBOM_DIFF_TEST_KEEP_TMP") == "1":
+    if os.environ.get("SPDX_DIFF_TEST_KEEP_TMP") == "1":
         # The delete parameter was added in Python 3.12
         extra_opts["delete"] = False
 
-    with tempfile.TemporaryDirectory(prefix="sbom-diff-", **extra_opts) as d:
+    with tempfile.TemporaryDirectory(prefix="spdx-diff-", **extra_opts) as d:
         yield pathlib.Path(d)

tests/conftest.py

@@ -8,7 +8,7 @@
 
 
 def exec_tool(tmp_dir: pathlib.Path, args: list[str]) -> None:
-    cmd = ["sbom-diff"]
+    cmd = ["spdx-diff"]
     cmd.extend(args)
 
     subprocess.run(
@@ -87,7 +87,7 @@ def check(self, json_data: dict[str, Any]) -> None:
         )
 
 
-def _run_sbom_diff_check(
+def _run_spdx_diff_check(
     tmp_dir: pathlib.Path,
     out_name: str,
     sbom_data_path: pathlib.Path,
@@ -116,7 +116,7 @@ def _run_sbom_diff_check(
     exp_diff.check(ret_diff)
 
 
-def run_sbom_diff_check(
+def run_spdx_diff_check(
     tmp_dir: pathlib.Path,
     sbom_data_path: pathlib.Path,
     sbom_ref: str,
@@ -127,7 +127,7 @@ def run_sbom_diff_check(
     if extra_args is None:
         extra_args = []
 
-    _run_sbom_diff_check(
+    _run_spdx_diff_check(
         tmp_dir,
         "diff.json",
         sbom_data_path,
@@ -138,7 +138,7 @@ def run_sbom_diff_check(
     )
 
     if exp_diff.same_expect_ignore_proprietary:
-        _run_sbom_diff_check(
+        _run_spdx_diff_check(
             tmp_dir,
             "diff2.json",
             sbom_data_path,