DIY Disclosure files: Difference between revisions

From OSSelot
Jump to navigation Jump to search
(Improved description of document formats, added radio button to fall back to unmodified SPDX standard)
(Tried to improve some radio button labels and extended the explanation of access via browser)
Line 8: Line 8:
The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.
The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.
===Call from browser===
===Call from browser===
This example retrieves the data of the "angular" package in version 15.2.2 and creates a disclosure document with copyright notices per file plus all licenses referenced (option "-lr") and prepended package information (option "-p"). The related URL is [https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p].
The calling convention of the URL is
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki>
where <design> and <features> may be any of the related command line options of the Python script [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure]. For example, to retrieve a disclosure document of the "angular" package in version 15.2.2 with copyright notices and license references by file followed by a list with all referenced licenses (option "-lr") and prepended package information (option "-p") the URL [https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p] may be used.
===Call from command line===
===Call from command line===
To create disclosure documents from arbitrary curated <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> packages with individually selected document format and features the following shell script can be used:
To create disclosure documents from arbitrary curated <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> packages with individually selected document format and features the following shell script can be used:
Line 42: Line 44:
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<label for="bsdtext"> Unreferenced licenses, then copyright notices and licenses by file, verbatim texts of non-template BSD-type licenses</label><br>
<label for="bsdtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of non-template BSD-type licenses</label><br>
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<label for="hashedtext"> Unreferenced licenses, then copyright notices and licenses by file, verbatim texts of all non-template licenses</label><br>
<label for="hashedtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of all non-template licenses</label><br>
<input type="radio" id="text" name="licensing" value="-lt">
<input type="radio" id="text" name="licensing" value="-lt">
<label for="text"> Unreferenced licenses, then copyright notices and verbatim license texts by file</label><br>
<label for="text"> Copyright notices and verbatim license texts by file</label><br>
<h5>Additional features</h5>
<h5>Additional features</h5>
<input type="checkbox" id="checksums" name="checksums">
<input type="checkbox" id="checksums" name="checksums">

Revision as of 13:47, 8 October 2023

Create individually designed disclosure files

This interface uses a script available from the SPDX2Disclosure repository.

Encapsulate the search Web script into a shell script to provide a command line interface for creating individually designed disclosure files

Web interface to immediately use the above described script and search for a given package to create a disclosure document according to the given settings

Overall design







Additional features




Look for software packages that may have already been curated at O and provide links to the related individually designed disclosure documents that will be created on the fly



Interface to obtain standard disclosure documents

A similar interface provides for retrieving the standard disclosure files without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.

Interface to obtain a list of licenses

A similar interface provides for listing the licenses that a particular software package uses instead of the entire disclosure documents.