tools-golang

tools-golang is a collection of Go packages intended to make it easier for Go programs to work with SPDX® files.

This software is in an early state, and its API may change significantly.

What it does

tools-golang currently works with files conformant to version 2.1 of the SPDX specification, available at: https://spdx.org/specifications

tools-golang provides the following packages:

spdx - in-memory data model for the sections of an SPDX document
tvloader - tag-value file loader
tvsaver - tag-value file 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
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 other than v2.1
work with RDF files
convert between RDF and tag-value files, or between different versions
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

At present, tools-golang does not require anything outside the Go standard library.

Licenses

As indicated in LICENSE-code.txt, 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.txt, 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