README
¶
SPDX tools-golang
tools-golang is a collection of Go packages intended to make it easier for Go programs to work with SPDX® files.
Recent news
2022-03-27: v0.3.0-rc1: added support for saving SPDX JSON files as well as other improvements and bugfixes. See RELEASE-NOTES.md for full details (to be updated for v0.3.0 prior to final release).
What it does
tools-golang currently works with files conformant to versions 2.1 and 2.2 of the SPDX specification, available at: https://spdx.dev/specifications
tools-golang provides the following packages:
- spdx - in-memory data model for the sections of an SPDX document
- tvloader - tag-value document loader
- tvsaver - tag-value document saver
- rdfloader - RDF document loader
- jsonloader - JSON document loader
- jsonsaver - JSON document saver
- builder - builds "empty" SPDX document (with hashes) for directory contents
- idsearcher - searches for SPDX short-form IDs and builds SPDX document
- licensediff - compares concluded licenses between files in two packages
- reporter - generates basic license count report from SPDX document
- spdxlib - various utility functions for manipulating SPDX documents in memory
- utils - various utility functions that support the other tools-golang packages
Examples for how to use these packages can be found in the examples/
directory.
What it doesn't do
tools-golang doesn't currently do any of the following:
- work with files under any version of the SPDX spec prior to v2.1
- convert between different versions of SPDX documents (e.g., from 2.1 to 2.2)
- enable applications to interact with SPDX files without needing to care (too much) about the particular SPDX file version
We are working towards adding functionality for all of these. Code contributions are welcome!
Requirements
tools-golang uses https://github.com/spdx/gordf to manage RDF input and output.
Other than that, tools-golang does not require anything outside the Go standard library.
Documentation
SPDX tools-golang documentation is available on the pkg.go.dev website at https://pkg.go.dev/github.com/spdx/tools-golang.
Contributors
Thank you to all of the contributors to spdx/tools-golang. A full list can be found in the GitHub repo and in the release notes.
In particular, thank you to the following for major contributions:
JSON parsing and saving support was added by @specter25 as part of his Google Summer of Code 2021 project.
RDF parsing support was added by @RishabhBhatnagar as part of his Google Summer of Code 2020 project.
Licenses
As indicated in LICENSE-code, tools-golang source code files are
provided and may be used, at your option, under either:
- Apache License, version 2.0 (Apache-2.0), OR
- GNU General Public License, version 2.0 or later (GPL-2.0-or-later).
As indicated in LICENSE-docs, tools-golang documentation files are
provided and may be used under the Creative Commons Attribution
4.0 International license (CC-BY-4.0).
This README.md file is documentation:
SPDX-License-Identifier: CC-BY-4.0
Directories
¶
| Path | Synopsis |
|---|---|
|
Package builder is used to create tools-golang data structures for a given directory path's contents, with hashes, etc.
|
Package builder is used to create tools-golang data structures for a given directory path's contents, with hashes, etc. |
|
examples
|
|
|
Package idsearcher is used to search for short-form IDs in files within a directory, and to build an SPDX Document containing those license findings.
|
Package idsearcher is used to search for short-form IDs in files within a directory, and to build an SPDX Document containing those license findings. |
|
saver2v2
Package saver2v2 contains functions to render and write a json formatted version of an in-memory SPDX document and its sections (version 2.2).
|
Package saver2v2 contains functions to render and write a json formatted version of an in-memory SPDX document and its sections (version 2.2). |
|
Package licensediff is used to generate a "diff" between the concluded licenses in two SPDX Packages, using the filename as the match point.
|
Package licensediff is used to generate a "diff" between the concluded licenses in two SPDX Packages, using the filename as the match point. |
|
parser2v2
SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later copied from tvloader/parser2v2/types.go
|
SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later copied from tvloader/parser2v2/types.go |
|
Package reporter contains functions to generate a basic license count report from an in-memory SPDX Package section whose Files have been analyzed.
|
Package reporter contains functions to generate a basic license count report from an in-memory SPDX Package section whose Files have been analyzed. |
|
Package spdx contains the struct definition for an SPDX Document and its constituent parts.
|
Package spdx contains the struct definition for an SPDX Document and its constituent parts. |
|
Package spdxlib contains convenience and utility functions for working with an SPDX document that has already been created in memory.
|
Package spdxlib contains convenience and utility functions for working with an SPDX document that has already been created in memory. |
|
Package tvloader is used to load and parse SPDX tag-value documents into tools-golang data structures.
|
Package tvloader is used to load and parse SPDX tag-value documents into tools-golang data structures. |
|
parser2v1
Package parser2v1 contains functions to read, load and parse SPDX tag-value files.
|
Package parser2v1 contains functions to read, load and parse SPDX tag-value files. |
|
parser2v2
Package parser2v2 contains functions to read, load and parse SPDX tag-value files, version 2.2.
|
Package parser2v2 contains functions to read, load and parse SPDX tag-value files, version 2.2. |
|
Package tvsaver is used to save tools-golang data structures as SPDX tag-value documents.
|
Package tvsaver is used to save tools-golang data structures as SPDX tag-value documents. |
|
saver2v1
Package saver2v1 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections (version 2.1).
|
Package saver2v1 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections (version 2.1). |
|
saver2v2
Package saver2v2 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections (version 2.2).
|
Package saver2v2 contains functions to render and write a tag-value formatted version of an in-memory SPDX document and its sections (version 2.2). |
|
Package utils contains various utility functions to support the main tools-golang packages.
|
Package utils contains various utility functions to support the main tools-golang packages. |