From aefa151f7bb52d42ce8a09db09919f024070b51c Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 23 Jun 2026 05:52:49 +0100 Subject: [PATCH 1/2] Add link to API doc in README and pyproject.toml - Add API doc link to README - Update pyproject.toml - Add more project.urls, including API doc - Use hyphen in project name (PEP 503 normalized form of repository name) Signed-off-by: Arthit Suriyawongkul --- README.md | 15 +++++++++------ pyproject.toml | 11 +++++++---- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 23170f2..e1b38ad 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ -# SPDX Python model +# spdx-python-model [![PyPI - Version](https://img.shields.io/pypi/v/spdx-python-model)](https://pypi.org/project/spdx-python-model/) ![Apache-2.0 license](https://img.shields.io/github/license/spdx/spdx-python-model) -Generated Python code for [SPDX specification version 3][spdx-spec]. +`spdx-python-model` is a Python library for working with the SPDX 3 data model. -All bindings in this repository are generated using -[shacl2code](https://github.com/JPEWdev/shacl2code) at the time the package is -built. +Read the [API documentation](https://spdx.github.io/spdx-python-model/). + +All bindings in this repository are auto-generated from the RDF and SHACL +definitions of the [SPDX specification version 3][spdx-spec] using +[shacl2code](https://github.com/JPEWdev/shacl2code) during the package build +process. **NOTE:** The bindings are pretty low level, intended for more directly manipulating SPDX files. While they are fully functions, they lack higher level helper functions that may be useful for creating SPDX documents. If you want a higher level approach, please see the [SPDX Python Tools](https://github.com/spdx/tools-python) (however, it -doesn't yet support SPDX 3) +doesn't yet support SPDX 3). [spdx-spec]: https://spdx.org/specifications diff --git a/pyproject.toml b/pyproject.toml index af0ee34..94b511c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [project] -name = "spdx_python_model" +name = "spdx-python-model" description = "SPDX Model Python Bindings" dynamic = ["version"] dependencies = [] @@ -29,6 +29,7 @@ classifiers = [ "Programming Language :: Python :: 3.14", ] license = "Apache-2.0" +license-files = ["LICENSE"] [project.optional-dependencies] dev = [ @@ -38,9 +39,11 @@ dev = [ ] [project.urls] -Homepage = "https://github.com/spdx/spdx-python-model" -Repository = "https://github.com/spdx/spdx-python-model.git" -Issues = "https://github.com/spdx/spdx-python-model/issues" +homepage = "https://spdx.github.io/spdx-python-model/" +repository = "https://github.com/spdx/spdx-python-model.git" +download = "https://github.com/spdx/spdx-python-model/releases" +documentation = "https://spdx.github.io/spdx-python-model/doc/" +issues = "https://github.com/spdx/spdx-python-model/issues" [build-system] requires = [ From 93e463615cf6fa7260bb3895f82ae6a85fcd66a3 Mon Sep 17 00:00:00 2001 From: Arthit Suriyawongkul Date: Tue, 23 Jun 2026 06:04:44 +0100 Subject: [PATCH 2/2] Use spdx-python-model name everywhere Signed-off-by: Arthit Suriyawongkul --- www/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/www/index.html b/www/index.html index f98233a..82e9913 100644 --- a/www/index.html +++ b/www/index.html @@ -4,7 +4,7 @@ - SPDX Python Model + spdx-python-model