DIY Disclosure files: Difference between revisions

From OSSelot
Jump to navigation Jump to search
(Added section on the technical background, but display it only on demand)
(Made a number of corrections)
Line 6: Line 6:
<div id="showondemand" style="display: none;">
<div id="showondemand" style="display: none;">
</html>
</html>
To create a disclosure file that relates to a given package name and version from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository and design it with respect to the display of licenses and other additional features the following shell script can be used. It selects an additional section with copyright notices per file plus all licenses referenced (option "-lr") and prepending package information (option "-p").
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 of from command line using a shell script.
===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].
===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 optional design and features the following shell script can be used:
  #!/bin/bash
  #!/bin/bash
   
   
  if test -z "$1" -o -z "$2"
  if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"
  then
  then
   echo "Usage: $0 <package> <version>"
   echo "Usage: $0 <package> <version> <design> <features>"
   exit 1
   exit 1
  fi
  fi
  package="$1"
  package="$1"
  version="$2"
  version="$2"
design="$3"
features="$4"
  if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`
  if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`
  then
  then
   wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package&-lr&-p"</nowiki>
   wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki>
  fi
  fi
The output of this script can then be adapted to the actual file set of the binary software distribution and given to the recipient of the software upon delivery as an important step toward compliance with the license terms. Possible further steps to license compliance are the adaptation of other legal materials such as terms and conditions and, if the license imposes this obligation, the immediate provision or an appropriate written offer to deliver the source code.
The output of this script can then be adapted to the actual file set of the binary software distribution and given to the recipient of the software upon delivery as an important step toward compliance with the license terms. Possible further steps to license compliance are the adaptation of other legal materials such as terms and conditions and, if the license imposes this obligation, the immediate provision or an appropriate written offer to deliver the source code.

Revision as of 18:54, 7 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 and 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.