From 9fff978cf858105552f4145e1d9c0d4dc8fe3bcc Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 8 Apr 2025 12:51:28 +0100 Subject: [PATCH 1/5] Suggest pipx install instead of pip install in README Suggest to install spdx3-validate with pipx, so it will be installed in an isolated environment and make the command available globally. ```shell pipx install spdx3-validate ``` Signed-off-by: Arthit Suriyawongkul --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 649df3b..4e4084b 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ useful. This includes: ## Installation -`spdx3-validate` can be installed using `pip`: +`spdx3-validate` can be installed using `pip` and `pipx`: ```shell -python3 -m pip install spdx3-validate +pipx install spdx3-validate ``` ## Developing From c332884984f3041209e4664a16dded9e26aa945b Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 8 Apr 2025 12:53:02 +0100 Subject: [PATCH 2/5] Update README.md Signed-off-by: Arthit Suriyawongkul --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e4084b..5434b23 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,13 @@ useful. This includes: ## Installation -`spdx3-validate` can be installed using `pip` and `pipx`: +`spdx3-validate` can be installed using `pip` and [`pipx`](https://github.com/pypa/pipx): + +```shell +python3 -m pip install spdx3-validate +``` + +or ```shell pipx install spdx3-validate From 3a4b8bcf7b540f11fceebc68b0db82dc1bb0f262 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 8 Apr 2025 12:59:06 +0100 Subject: [PATCH 3/5] Add usage Signed-off-by: Arthit Suriyawongkul --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 5434b23..355550b 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,32 @@ or pipx install spdx3-validate ``` +## Usage + +```shell +spdx3-validate -j sbom.json +``` + +### Options + +All available options can be listed by this command: + +```shell +spdx3-validate -h +``` + +```text +options: + -h, --help show this help message and exit + --json, -j JSON Validate SPDX 3 JSON file (URL, path, or '-') + --spdx-version, -s {3.0.0,3.0.1,auto} + SPDX Version to use, or 'auto' to determine version + from input files + --version, -V show program's version number and exit + --no-merge Do not validate merged documents + --quiet, -q Run quietly (do not show progress) +``` + ## Developing Developing on `spdx3-validate` is best done using a virtual environment. You From 854d3699d29a615229c41309244fd9ee5f63a821 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 8 Apr 2025 13:01:59 +0100 Subject: [PATCH 4/5] Update README.md Signed-off-by: Arthit Suriyawongkul --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 355550b..3029e6f 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ useful. This includes: ## Installation -`spdx3-validate` can be installed using `pip` and [`pipx`](https://github.com/pypa/pipx): +`spdx3-validate` can be installed using either `pip` or [`pipx`](https://github.com/pypa/pipx): ```shell python3 -m pip install spdx3-validate From 437bf311a8e9f78160e120722c2303dc2f01f733 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 4 Nov 2025 10:31:14 +0000 Subject: [PATCH 5/5] Update README.md Signed-off-by: Arthit Suriyawongkul --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3029e6f..7fcfed1 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ useful. This includes: ## Installation -`spdx3-validate` can be installed using either `pip` or [`pipx`](https://github.com/pypa/pipx): +`spdx3-validate` can be installed using either `pip` +or [`pipx`](https://github.com/pypa/pipx): ```shell python3 -m pip install spdx3-validate