This is the source code repository for the tool that generates license data found in the license-list-data repository. The source for the data is located in the license-list-XML repository.
The package is available in
Maven Central
(organization: org.spdx
, artifact: licenseListPublisher
).
See the file CONTRIBUTING.md for information on making contributions to the LicenseListPublisher.
The command line interface of the licenseListPublisher can be used like this:
java -jar licenseListPublisher.jar <function> <parameters>
Where the following functions are supported:
LicenseRDFAGenerator
- Generates license dataTestLicenseXML
- Tests a license XML file
Usage:
LicenseRDFAGenerator licenseXmlFileOrDir outputDirectory [version] [releasedate] [testfiles] [ignoredwarnings]
licenseXmlFileOrDir - a license XML file or a directory of license XML files
outputDirectory - Directory to store the output from the license generator
[version] - Version of the SPDX license list
[releasedate] - Release date of the SPDX license list
[testfiles] - Directory of original text files to compare the generated licenses against
[ignoredwarnings] - Either a file name or a comma separated list of warnings to be ignored
WARNING: Running the LicenseRDFAGenerator for a single file will overwrite any index.html, licenses.json etc. with the single file results.
Usage:
TestLicenseXML licenseXmlFile textFile
licenseXmlFile XML - file to test
textFile - Text file which should match the the license text for the licenseXmlFile
testDirectory - Optional directory of test files in the form {license-id}/(license|header|exception)/(good|bad)/{test-id}.txt
See the NOTICE file for licensing information including info from 3rd Party Software.
See LICENSE file for full license text.
SPDX-License-Identifier: Apache-2.0
PackageLicenseDeclared: Apache-2.0
You need Apache Maven to build the project:
mvn clean install