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 = [ 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