DIY Disclosure files: Difference between revisions

From OSSelot
Jump to navigation Jump to search
(The updated "-c" option of the converter only enables SHA256 checksums)
m (Updated OSSelot logo to new font feature)
Line 7: Line 7:
<div id="showondemand" style="display: none;">
<div id="showondemand" style="display: none;">
</html>
</html>
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;">OSSelot</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===
The calling convention of the URL is
The calling convention of the URL is
Line 13: Line 13:
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.
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;">OSSelot</span> packages with individually selected document format and features the following shell script can be used:
  #!/bin/bash
  #!/bin/bash
   
   
Line 57: Line 57:
<input type="checkbox" id="preamble" name="preamble">
<input type="checkbox" id="preamble" name="preamble">
<label for="preamble"> Prepend package information</label><br>
<label for="preamble"> Prepend package information</label><br>
<h4>Look for software packages that may have already been curated at <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> and provide links to the related individually designed disclosure documents that will be created on the fly</h4>
<h4>Look for software packages that may have already been curated at <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> and provide links to the related individually designed disclosure documents that will be created on the fly</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'diydisclosure');" size="30"><button onclick="searchOSSelot(this, 'diydisclosure');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> disclosure document</button><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'diydisclosure');" size="30"><button onclick="searchOSSelot(this, 'diydisclosure');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> disclosure document</button><br />
<span style="display: none;"></span>
<span style="display: none;"></span>
<br />
<br />

Revision as of 15:46, 1 November 2023

Create individually do-it-yourself 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 OSSelot 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.