Skip to content

Add link to API doc in README and pyproject.toml #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bact merged 2 commits into from
Jun 23, 2026
Merged

Add link to API doc in README and pyproject.toml #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aefa151
Add link to API doc in README and pyproject.toml
bact Jun 23, 2026
93e4636
Use spdx-python-model name everywhere
bact Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
11 changes: 7 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "spdx_python_model"
name = "spdx-python-model"
description = "SPDX Model Python Bindings"
dynamic = ["version"]
dependencies = []
Expand Down Expand Up @@ -29,6 +29,7 @@ classifiers = [
"Programming Language :: Python :: 3.14",
]
license = "Apache-2.0"
license-files = ["LICENSE"]

[project.optional-dependencies]
dev = [
Expand All @@ -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 = [
Expand Down
4 changes: 2 additions & 2 deletions www/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SPDX Python Model</title>
<title>spdx-python-model</title>
<meta name="description"
content="Python bindings for the SPDX 3 data model. Install instructions. API documentation.">
<style>
Expand Down Expand Up @@ -44,7 +44,7 @@
</head>

<body>
<h1>SPDX Python Model</h1>
<h1>spdx-python-model</h1>
<p class="tagline">Python bindings for the SPDX 3 data model.</p>

<h2>Install</h2>
Expand Down