==Retrieve files from the project's Github repository==
When accessing project files via scripts or programs, it must be taken into account that these may only be available in gzip-compressed format, as otherwise their size would exceed the limit set by Github. Therefore, if an access error occurs, a second attempt should be made, appending the file extension “.gz” to the file name and decompressing the file after downloading.

====Example local file access with a Python script====
<syntaxhighlight lang="python">
#!/usr/bin/env python3
import json
import gzip

def readOSSelot(name):
osselotjson = ''
try:
osselotfile = open(name, 'r')
jsonloader = json.load
jsoncloser = osselotfile
except:
try:
gzipfile = gzip.open(name + '.gz', 'rb')
osselotfile = gzipfile.read()
jsonloader = json.loads
jsoncloser = gzipfile
except:
return ''
try:
osselotjson = jsonloader(osselotfile)
except json.decoder.JSONDecodeError:
pass
jsoncloser.close()
return osselotjson

name = 'package-analysis/analysed-packages/bash/version-5.1.16/bash-5.1.16.spdx.json'
bash = readOSSelot(name)
if bash != '':
print(bash['packages'][0]['name'])

name = 'package-analysis/analysed-packages/linux/version-6.0/linux-6.0.spdx.json'
linux = readOSSelot(name)
if linux != '':
print(linux['packages'][0]['name'])
</syntaxhighlight>
Run the script:
<syntaxhighlight lang="bash">
$ readOSSelot.py
bash-5.1.16.tar.gz
linux-6.0.tar.xz
</syntaxhighlight>
In both cases, the correct file was opened and its contents returned, even though in the second case the name of a non-existent file was specified.
====Example Web server access with a Python script====
<syntaxhighlight lang="python">
#!/usr/bin/env python3
import json
from urllib import request
import gzip

def fetchOSSelot(url):
try:
osselot = request.urlopen(url)
osselotdata = osselot.read()
except:
try:
osselotgz = request.urlopen(url + '.gz')
osselotgzdata = osselotgz.read()
osselotdata = gzip.decompress(osselotgzdata)
except:
return ''
try:
osselotjson = json.loads(osselotdata)
return osselotjson
except json.decoder.JSONDecodeError:
return ''

url = 'https://github.com/Open-Source-Compliance/package-analysis/raw/refs/heads/main/analysed-packages/bash/version-5.1.16/bash-5.1.16.spdx.json'
bash = fetchOSSelot(url)
if bash != '':
print(bash['packages'][0]['name'])

url = 'https://github.com/Open-Source-Compliance/package-analysis/raw/refs/heads/main/analysed-packages/linux/version-6.0/linux-6.0.spdx.json'
linux = fetchOSSelot(url)
if linux != '':
print(linux['packages'][0]['name'])
</syntaxhighlight>
Run the script:
<syntaxhighlight lang="bash">
$ fetschOSSelot.py
bash-5.1.16.tar.gz
linux-6.0.tar.xz
</syntaxhighlight>
As above, but here when accessing the file via network, the correct file was downloaded and its contents returned, even though in the second case the name of a non-existent file was specified.
====Retrieving uncompressed files from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository mirror====
Finally, if decompressing is by any reason not an option, uncompressed files can be retrieved immediately from the repository mirror at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Web site
<syntaxhighlight lang="python">
#!/usr/bin/env python3
import json
from urllib import request
import gzip

def fetchOSSelot2(url):
try:
osselot = request.urlopen(url)
except:
try:
osselot = request.urlopen(url.replace('github.com', 'osselot.org'))
except:
return ''
osselotdata = osselot.read()
try:
osselotjson = json.loads(osselotdata)
return osselotjson
except json.decoder.JSONDecodeError:
return ''

url = 'https://github.com/Open-Source-Compliance/package-analysis/raw/refs/heads/main/analysed-packages/bash/version-5.1.16/bash-5.1.16.spdx.json'
bash = fetchOSSelot2(url)
if bash != '':
print(bash['packages'][0]['name'])

url = 'https://github.com/Open-Source-Compliance/package-analysis/raw/refs/heads/main/analysed-packages/linux/version-6.0/linux-6.0.spdx.json'
linux = fetchOSSelot2(url)
if linux != ''
print(linux['packages'][0]['name'])
</syntaxhighlight>
Run the script:
<syntaxhighlight lang="bash">
$ fetschOSSelot2.py
bash-5.1.16.tar.gz
linux-6.0.tar.xz
</syntaxhighlight>
Again as above, when accessing the file via network, the correct file was downloaded and its contents returned, even though in the second case the name of a file was specified that only exists in uncompressed form on the repository mirror at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Web site.

Retrieve files from the repository

2025-06-13T10:47:54Z

CarstenEmde: Added output of script and explanation below the codes

Main Page

2025-06-12T22:48:43Z

CarstenEmde: Added secstion on large repository files

__NOTOC__
== Welcome to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Wiki! ==

This Wiki was created to facilitate day-to-day work with the resources of the [https://www.osselot.org <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project], especially when accessing them in batch mode, e.g. as part of a software release build.

==[[Search]] for a package==
[[Search|Find out]] whether a particular version of a software package is supported by <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> and has already been curated. A particular Web script is provided for this purpose, and an interactive Web interface is available to test and use this feature.

==Show [[Callgraphs|callgraphs and dependency lists]]==
A shell script is provided to encapsulate the [[Search|Web search script]] and show callgraphs of ELF binaries related to <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> packages. One more interactive Web interface is here available to test and use this feature. In addition, links are provided to dependency lists and build scripts.

==Obtain [[Disclosure_files|disclosure files]]==
A shell script is provided to encapsulate the [[Search|Web search script]] and obtain the related disclosure files. Another interactive Web interface is available to test and use this feature.

==Create individually designed [[DIY_Disclosure_files|do-it-yourself disclosure files]]==
Define a set of custom characteristics of what the disclosure file should look like, search for a package and create a custom disclosure file for it.

==Obtain [[Licenses|licensing information]]==
Another Web script is available that also encapsulates the internal algorithm of the [[Search|Web search script]], but then generates a list of licenses that are used in a given software package. The script accepts as argument either a package name or a package name along with a version. In the former case the licenses of all available versions are listed, whereas in the latter the output is restricted to the specified version.

==Obtain curation data in various formats using a [[REST]] interface==
The entire curation data of a software package can be retrieved in [[JSON]] format, curation data of a particular version can be retrieved in [[RDF-XML]], [[SPDX2TV]] or [[YAML]] format.

==Reuse existing material in case of version mismatch==
If a particular version of a software package has not been curated before, but another one that may be close to it has, then FOSSology's reuse feature can be applied. Details are given in the presentation and video material on the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> home page: Please check out [https://www.osselot.org/index.php?s=presentations "Use case 2" at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> presentations].

==Contributing to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project==
How to contribute to the project if a package that is not yet included with <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> has been externally curated? Contributions are greatly appreciated, and therefore we would like to encourage as many users as possible to contribute. The more versions of more packages that are curated, the more beneficial the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project will be. However, to maintain confidence in the material, a rigorous vetting process was instituted. Volunteers are asked to first contact the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Officer via [mailto:office@osadl.org?subject=OSSelot-volunteer email]. The easiest next step is then probably to arrange a video conference, get to know each other, and understand the basic principles of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curation process. From that moment, new software packages can be curated and provided in the fork tree. The maintainer will then review the newly provided curation data in close collaboration with the contributor, and once the review is successful, the new curation data will be included and made publicly available through the repository. The contributor's and reviewer's names will be indicated in the README file of the package.

==Best practices==
====[[Curation guideline|How to curate data]]====
High-quality curation data are the cornerstone of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project. To ensure that this quality is maintained, every contribution is thoroughly reviewed and only curators with sufficient expertise in FOSS licensing contribute to the database. A [[curation guideline]] on how data are curated for the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project is given here to ensure consistency.

==== [[SPDX2TV template]] ====
To avoid misunderstandings when exchanging SPDX files, an SPDX tag:value template is given [[SPDX2TV template|here]]. This shows which tags are used in the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project and how they are interpreted.

====[[FOSSology]]====
In order to use the [[FOSSology]] Open Source curation administration tool in connection with the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project (when re-using the data and also when contributing to the project), a number of conventions should be observed.

====[[Scancode]]====
Normally, the [[Scancode]] Open Source scanning tool is used under the control of [[FOSSology]] in this project; however, to fine-tune or confirm the results it may be necessary to run the tool separately from command line. If this is done, the command line options should match the conventions of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project.

====[[Retrieve files from the repository]]====
Repository files at the [https://github.com/Open-Source-Compliance/package-analysis Github project page] are limited in size. Therefore, some very large files need to be compressed. In such cases, the gzip compression method was used and the file name suffixed by ".gz". Some examples of how to retrieve such files are given [[Retrieve files from the repository|here]].

2023-11-01T14:43:56Z

CarstenEmde: Updated OSSelot logo to new font feature

SPDX2TV

2023-11-01T14:43:24Z

CarstenEmde: Updated OSSelot logo to new font feature

==Obtain curation data in SPDX2TV format==
====Single version====
To obtain curation data of a single version of a software package in SPDX2TV format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/spdx/<package>/<version>
</pre>
<pre>
https://www.osselot.org:3263/spdx/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/spdx/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
This [[REST]] interface for data of a curated software package in SPDX2TV format only permits to retrieve a single version at a time. Only the [[JSON]] interface concatenates all curated versions of a software package to a data array.

====Format SPDX2TV text file in browser====
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as
<html>
<a href="https://www.osselot.org:3263/spdx/dbus/1.15.2">DBus version 1.15.2</a>
</html>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>Search for a package, select it, submit it to the REST interface for SPDX2TV formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curation data in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'restspdx');" size="30" /><button onclick="searchOSSelot(this, 'restspdx');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[RDF-XML]] and [[YAML]] format.

YAML

2023-11-01T14:42:54Z

CarstenEmde: Updated OSSelot logo to new font feature

==Obtain curation data in YAML format==
====Single version====
To obtain curation data of a single version of a software package in YAML format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/yaml/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/yaml/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/yaml/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
This [[REST]] interface for data of a curated software package in YAML format only permits to retrieve a single version at a time. Only the [[JSON]] interface concatenates all curated versions of a software package to a data array.

====Format YAML text file in browser====
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as
<html>
<a href="https://www.osselot.org:3263/yaml/dbus/1.15.2">DBus version 1.15.2</a>
</html>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>Search for a package, select it, submit it to the REST interface for YAML formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curation data in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'restyaml');" size="30" /><button onclick="searchOSSelot(this, 'restyaml');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[RDF-XML]] and [[SPDX2TV]] format.

JSON

2023-11-01T14:42:25Z

CarstenEmde: Updated OSSelot logo to new font feature

==Obtain curation data in JSON format==
====Single version====
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/json/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/json/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
The command to obtain JSON formatted data of all available versions of a software package is very similar to the above except that the "version" part is not given such as
<syntaxhighlight lang="bash">
wget -qO - http://wwww.osselot.org:3262/json/dbus
</syntaxhighlight>

====Format JSON file in browser====
If a browser supports display of JSON data either natively or after having installed an appropriate extension, JSON data may be rendered and interactively inspected using links such as
<html>
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a>
</html>
or even
<html>
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.
</html>

<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>For browsers with generic JSON support: Search for a package, select it, submit it to the REST interface for JSON formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curation data in a new window</h4>
<i>(Same as above, some of the packages may take a long time to render. If the browser does not know how to handle JSON code, use the below OSADL built-in display version.)</i><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'restjson');" size="30" /><button onclick="searchOSSelot(this, 'restjson');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>

<html>
<h4>If the browser does not generically support JSON display: Search for a package, select it, let the JSON formatted <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curation data be validated for syntax correctness and colorified, and display the code in a new window</h4>
<i>(Also same as above, some of the packages may take a long time to render.)</i><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'validatejson');" size="30" /><button onclick="searchOSSelot(this, 'validatejson');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.

Scancode

2023-11-01T14:41:36Z

CarstenEmde: Updated OSSelot logo to new font feature

==Installation==
The Scancode toolkit can be downloaded from the [https://github.com/nexB/scancode-toolkit/releases/latest related Github repository]. The landing page of the company behind Scancode is [https://www.nexb.com/scancode/ here].
==Documentation==
Online documentation of the Scancode toolkit is available [https://scancode-toolkit.readthedocs.io/en/stable/ here].
==Scancode conventions of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project ==
Default options for analysis:<syntaxhighlight lang="bash">
scancode -cli --license-text -json [package name-version].json [package]
</syntaxhighlight>c: copyrights; l: licenses; i: file information; --license-text: include full license text

FOSSology

2023-11-01T14:41:06Z

CarstenEmde: Updated OSSelot logo to new font feature

==Installation==
The Fossology software can be downloaded from the [https://www.fossology.org/ project's home page].
==Manual addition of [[Scancode]]==
In addition to the default installation, the [[Scancode]] Open Source scan tool should be installed, and an interface from the FOSSology instance to it should be configured. The rationale behind the recommendation to use a certain variety of scanners is that each scanner has its own strengths and weaknesses and by combining the individual scan findings, the overall result can be optimized.

== Customization ==
In the SPDX standard, licenses are denoted by a short identifier (e.g. GPL-2.0-only or LicenseRef-MIT-customized). Licenses that are not listed in the [https://spdx.org/licenses SPDX License List] are prefixed by "LicenseRef-", and in the section "License information" of the SPDX tag:value file, the full license text is given. Licenses with standard texts according to the [https://spdx.org/licenses SPDX License List] do not carry the "LicenseRef-" prefix, and their license text is not given in the tag:value file. For the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project however, the SPDX tag:value file is intended to be self-consistent, i.e. for every short license identifier the corresponding full license text must be given. In order to achieve this while ensuring the SPDX file can be valid, we have patched our Fossology installation to add the "LicenseRef-" prefix to all license identifiers. In our Fossology installation, the patch directory is /usr/local/share/fossology/patches and the patch list-all-license-texts-in-spdxtv-export.patch looks as follows:<syntaxhighlight lang="diff">
Index: fossology/spdx2/agent/template/spdx2-document.xml.twig
===================================================================
--- fossology.orig/spdx2/agent/template/spdx2-document.xml.twig
+++ fossology/spdx2/agent/template/spdx2-document.xml.twig
@@ -21,7 +21,7 @@
<rdfs:comment>
This document was created using license information and a generator from Fossology.
</rdfs:comment>
- {% for licenseId,licenseData in licenseTexts %}{% if licenseId starts with 'LicenseRef-' %}
+ {% for licenseId,licenseData in licenseTexts %}
<spdx:hasExtractedLicensingInfo>
{% if licenseId starts with 'LicenseRef-' %}
<spdx:ExtractedLicensingInfo rdf:about="{{ uri }}#{{ licenseId|replace({' ': '-'})|url_encode }}">
@@ -36,7 +36,7 @@
]]></spdx:extractedText>
</spdx:ExtractedLicensingInfo>
</spdx:hasExtractedLicensingInfo>
-{% endif %}{% endfor %}
+{% endfor %}
{{ packageNodes|replace({'\n':'\n '}) }}
</spdx:SpdxDocument>
</rdf:RDF>

Index: fossology/spdx2/agent/template/spdx2tv-document.twig
===================================================================
--- fossology.orig/spdx2/agent/template/spdx2tv-document.twig
+++ fossology/spdx2/agent/template/spdx2tv-document.twig
@@ -40,10 +40,10 @@ LicenseListVersion: 2.6
## License Information
##-------------------------

-{% for licenseId,licenseData in licenseTexts %}{% if licenseId starts with 'LicenseRef-' %}
+{% for licenseId,licenseData in licenseTexts %}
LicenseID: {{ licenseId|replace({' ': '-'}) }}
LicenseName: {{ licenseData['name'] }}
ExtractedText: <text> {{ licenseData['text']|replace({'<text>':'<text>','</text>':'</text>'})
|replace({'\f':''}) }} </text>

-{% endif %}{% endfor %}
+{% endfor %}
</syntaxhighlight>

==Community server==
The reference community FOSSology server <i>[https://fossy.osadl.org Fossy]</i> is available on the Internet and internally used for primary curation and review; however, it is not publicly available. Future contributors may be granted login to the <i>Fossy</i> server after they successfully underwent <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> curators' training.

==Basic workflow==
The basic workflow for clearing a package with Fossology is given on the [https://www.fossology.org/get-started/basic-workflow/ Fossology project page].

YAML

2023-10-12T10:13:10Z

CarstenEmde: Added links to other formats

==Obtain curation data in YAML format==
====Single version====
To obtain curation data of a single version of a software package in YAML format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/yaml/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/yaml/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/yaml/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
This [[REST]] interface for data of a curated software package in YAML format only permits to retrieve a single version at a time. Only the [[JSON]] interface concatenates all curated versions of a software package to a data array.

====Format YAML text file in browser====
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as
<html>
<a href="https://www.osselot.org:3263/yaml/dbus/1.15.2">DBus version 1.15.2</a>
</html>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>Search for a package, select it, submit it to the REST interface for YAML formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'restyaml');" size="30" /><button onclick="searchOSSelot(this, 'restyaml');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[RDF-XML]] and [[SPDX2TV]] format.

SPDX2TV

2023-10-12T10:12:10Z

CarstenEmde: Added links to other formats

==Obtain curation data in SPDX2TV format==
====Single version====
To obtain curation data of a single version of a software package in SPDX2TV format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/spdx/<package>/<version>
</pre>
<pre>
https://www.osselot.org:3263/spdx/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/spdx/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
This [[REST]] interface for data of a curated software package in SPDX2TV format only permits to retrieve a single version at a time. Only the [[JSON]] interface concatenates all curated versions of a software package to a data array.

====Format SPDX2TV text file in browser====
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as
<html>
<a href="https://www.osselot.org:3263/spdx/dbus/1.15.2">DBus version 1.15.2</a>
</html>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>Search for a package, select it, submit it to the REST interface for SPDX2TV formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'restspdx');" size="30" /><button onclick="searchOSSelot(this, 'restspdx');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[RDF-XML]] and [[YAML]] format.

JSON

2023-10-12T10:11:29Z

CarstenEmde: /* Other formats */

==Obtain curation data in JSON format==
====Single version====
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/json/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/json/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
The command to obtain JSON formatted data of all available versions of a software package is very similar to the above except that the "version" part is not given such as
<syntaxhighlight lang="bash">
wget -qO - http://wwww.osselot.org:3262/json/dbus
</syntaxhighlight>

====Format JSON file in browser====
If a browser supports display of JSON data either natively or after having installed an appropriate extension, JSON data may be rendered and interactively inspected using links such as
<html>
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a>
</html>
or even
<html>
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.
</html>

<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>For browsers with generic JSON support: Search for a package, select it, submit it to the REST interface for JSON formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
<i>(Same as above, some of the packages may take a long time to render. If the browser does not know how to handle JSON code, use the below OSADL built-in display version.)</i><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'restjson');" size="30" /><button onclick="searchOSSelot(this, 'restjson');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>

<html>
<h4>If the browser does not generically support JSON display: Search for a package, select it, let the JSON formatted <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data be validated for syntax correctness and colorified, and display the code in a new window</h4>
<i>(Also same as above, some of the packages may take a long time to render.)</i><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'validatejson');" size="30" /><button onclick="searchOSSelot(this, 'validatejson');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.

RDF-XML

2023-10-12T10:11:04Z

CarstenEmde: /* Other formats */

==Obtain curation data in RDF-XML format==
====Single version====
To obtain curation data of a single version of a software package in RDF-XML format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/xml/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/xml/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/xml/busybox/1.35.0
</syntaxhighlight>

====All available versions of a software package====
This [[REST]] interface for data of a curated software package in RDF-XML format only permits to retrieve a single version at a time. Only the [[JSON]] interface concatenates all curated versions of a software package to a data array.

====Format YAML text file in browser====
The curated data of a single version of a curated software package may be displayed in standard XML tree format in a browser such as
<html>
<a href="https://www.osselot.org:3263/xml/busybox/1.35.0">BusyBox version 1.35.0</a>
</html>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>Search for a package, select it, submit it to the REST interface for RDF-XML formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'restxml');" size="30" /><button onclick="searchOSSelot(this, 'restxml');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>

<html>
<h4>Search for a package, select it, submit the RDF-XML formatted data to the W3C RDF validation service and display the result in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'validatexml');" size="30" /><button onclick="searchOSSelot(this, 'validatexml');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[SPDX2TV]] and [[YAML]] format.

RDF-XML

2023-10-12T10:10:46Z

CarstenEmde: Added links to other formats

==Obtain curation data in RDF-XML format==
====Single version====
To obtain curation data of a single version of a software package in RDF-XML format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/xml/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/xml/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/xml/busybox/1.35.0
</syntaxhighlight>

====All available versions of a software package====
This [[REST]] interface for data of a curated software package in RDF-XML format only permits to retrieve a single version at a time. Only the [[JSON]] interface concatenates all curated versions of a software package to a data array.

====Format YAML text file in browser====
The curated data of a single version of a curated software package may be displayed in standard XML tree format in a browser such as
<html>
<a href="https://www.osselot.org:3263/xml/busybox/1.35.0">BusyBox version 1.35.0</a>
</html>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>Search for a package, select it, submit it to the REST interface for RDF-XML formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'restxml');" size="30" /><button onclick="searchOSSelot(this, 'restxml');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>

<html>
<h4>Search for a package, select it, submit the RDF-XML formatted data to the W3C RDF validation service and display the result in a new window</h4>
<input type="text" onkeyup="searchtextkeyup(event, this, 'validatexml');" size="30" /><button onclick="searchOSSelot(this, 'validatexml');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.

JSON

2023-10-12T10:09:52Z

CarstenEmde: Added links to other formats

==Obtain curation data in JSON format==
====Single version====
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:
<pre>
http://www.osselot.org:3262/json/<package>/<version>
</pre>
or
<pre>
https://www.osselot.org:3263/json/<package>/<version>
</pre>
such as in a <i>wget</i> command
<syntaxhighlight lang="bash">
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2
</syntaxhighlight>

====All available versions of a software package====
The command to obtain JSON formatted data of all available versions of a software package is very similar to the above except that the "version" part is not given such as
<syntaxhighlight lang="bash">
wget -qO - http://wwww.osselot.org:3262/json/dbus
</syntaxhighlight>

====Format JSON file in browser====
If a browser supports display of JSON data either natively or after having installed an appropriate extension, JSON data may be rendered and interactively inspected using links such as
<html>
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a>
</html>
or even
<html>
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.
</html>

<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i>

<html>
<script src="/scripts/osadl.js">
</script>
<h4>For browsers with generic JSON support: Search for a package, select it, submit it to the REST interface for JSON formatted data and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4>
<i>(Same as above, some of the packages may take a long time to render. If the browser does not know how to handle JSON code, use the below OSADL built-in display version.)</i><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'restjson');" size="30" /><button onclick="searchOSSelot(this, 'restjson');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>

<html>
<h4>If the browser does not generically support JSON display: Search for a package, select it, let the JSON formatted <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data be validated for syntax correctness and colorified, and display the code in a new window</h4>
<i>(Also same as above, some of the packages may take a long time to render.)</i><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'validatejson');" size="30" /><button onclick="searchOSSelot(this, 'validatejson');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br />
<span style="display: none;"></span>
<br />
</html>
====Other formats====
In addition to the above, the curated data are also available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.

DIY Disclosure files

2023-10-06T21:55:33Z

CarstenEmde:

=Create individually designed disclosure files=
<html>
<script src="/scripts/osadl.js">
</script>
<h5>Overall design</h5>
<input type="radio" id="none" name="licensing" checked="checked" value="-ln">
<label for="none"> Additional section with copyright notices per file</label><br>
<input type="radio" id="referenced" name="licensing" value="-lr">
<label for="referenced"> Same as first choice plus all licenses referenced</label><br>
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br>
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br>
<input type="radio" id="text" name="licensing" value="-lt">
<label for="text"> Same as first choice plus all licenses verbatim</label><br>
<h5>Additional features</h5>
<input type="checkbox" id="checksums" name="checksums">
<label for="checksums"> Include file checksums</label><br>
<input type="checkbox" id="numbered" name="numbered">
<label for="numbered"> Number files consecutively</label><br>
<input type="checkbox" id="preamble" name="preamble">
<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>
<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 />
<span style="display: none;"></span>
<br />

</html>

==Interface to obtain standard disclosure documents==
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without an interface to select licensing and features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.

DIY Disclosure files

2023-10-06T21:55:08Z

CarstenEmde:

=Create individually designed disclosure files=
<html>
<script src="/scripts/osadl.js">
</script>
<h5>Overall design</h5>
<input type="radio" id="none" name="licensing" checked="checked" value="-ln">
<label for="none"> Additional section with copyright notices per file</label><br>
<input type="radio" id="referenced" name="licensing" value="-lr">
<label for="referenced"> Same as first choice plus all licenses referenced</label><br>
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br>
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br>
<input type="radio" id="text" name="licensing" value="-lt">
<label for="text"> Same as first choice plus all licenses verbatim</label><br>
<h5>Additional features</h5>
<input type="checkbox" id="checksums" name="checksums">
<label for="checksums"> Include file checksums</label><br>
<input type="checkbox" id="numbered" name="numbered">
<label for="numbered"> Number files consecutively</label><br>
<input type="checkbox" id="preamble" name="preamble">
<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 are 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 />
<span style="display: none;"></span>
<br />

</html>

==Interface to obtain standard disclosure documents==
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without an interface to select licensing and features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.

DIY Disclosure files

2023-10-06T21:06:10Z

CarstenEmde:

=Create individually designed disclosure files=
<html>
<script src="/scripts/osadl.js">
</script>
<h5>Overall design</h5>
<input type="radio" id="none" name="licensing" checked="checked" value="-ln">
<label for="none"> Additional section with copyright notices per file</label><br>
<input type="radio" id="referenced" name="licensing" value="-lr">
<label for="referenced"> Same as first choice plus all licenses referenced</label><br>
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br>
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br>
<input type="radio" id="text" name="licensing" value="-lt">
<label for="text"> Same as first choice plus all licenses verbatim</label><br>
<h5>Additional features</h5>
<input type="checkbox" id="checksums" name="checksums">
<label for="checksums"> Include file checksums</label><br>
<input type="checkbox" id="numbered" name="numbered">
<label for="numbered"> Number files consecutively</label><br>
<input type="checkbox" id="preamble" name="preamble">
<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</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 />
<span style="display: none;"></span>
<br />

</html>

==Interface to obtain standard disclosure documents==
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without an interface to select licensing and features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.

DIY Disclosure files

2023-10-06T21:04:20Z

CarstenEmde:

=Create individually designed disclosure files=
<html>
<script src="/scripts/osadl.js">
</script>
<h5>Overall design</h5>
<input type="radio" id="none" name="licensing" checked="checked" value="-ln">
<label for="none"> Additional section with copyright notices per file</label><br>
<input type="radio" id="referenced" name="licensing" value="-lr">
<label for="referenced"> Same as first choice plus all licenses referenced</label><br>
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br>
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br>
<input type="radio" id="text" name="licensing" value="-lt">
<label for="text"> Same as first choice plus all licenses verbatim</label><br>
<h5>Additional features</h5>
<input type="checkbox" id="checksums" name="checksums">
<label for="checksums"> Include file checksums</label><br>
<input type="checkbox" id="numbered" name="numbered">
<label for="numbered"> Number files consecutively</label><br>
<input type="checkbox" id="preamble" name="preamble">
<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</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 />
<span style="display: none;"></span>
<br />

</html>

Material from multiple packages can each be given a title line and then concatenated.

==Interface to obtain standard disclosure documents==
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without an interface to select licensing and features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.

Disclosure files

2023-10-06T20:42:24Z

CarstenEmde:

=Obtain disclosure files=
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface==
To download the 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 the following shell script can be used:
#!/bin/bash

if test -z "$1" -o -z "$2"
then
echo "Usage: $0 <package> <version>"
exit 1
fi
package="$1"
version="$2"
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`
then
wget -qO - <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/$package/version-$version/$package-$version-OSS-disclosure.txt</nowiki>
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.

If the script is called "getdisclosure" and invoked for the example that was used on the [[Search|search]] page as
getdisclosure angular 15.2.2
a text is returned that is ready to be used:
<html>
<script src="/scripts/osadl.js">
</script>
<button onmousemove="mousemove(event);" onclick="showdisclosure(this)">angular/15.2.2 disclosure material</button>
</html>
==Web interface to immediately [[Search|search]] for a given package and provide links to the disclosure documents of found package repositories==
<html>
<h4>Look for other 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 disclosure documents</h4>

<input type="text" onkeyup="searchtextkeyup(event, this, 'disclosure');" size="30" /><button onclick="searchOSSelot(this, 'disclosure');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> disclosure document</button><br />
<span style="display: none;"></span>
<br />

</html>

Material from multiple packages can each be given a title line and then concatenated.

==Interface to obtain individually designed do-it-yourself disclosure documents==
A similar interface provides for obtaining [[DIY_Disclosure_files|individually designed do-it-yourself disclosure files]] with various ways to show licenses and add optional features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.

Licenses

2023-10-06T20:41:56Z

CarstenEmde: Added link to interface for DIY disclosure documents

=Obtain licenses=
==Shell script==
Use a shell script to encapsulate the same search mechanism as used in the [[Search|search]] Web script, but process the result further to extract the licenses of a given package and optionally given version from the related SPDX tag:value files at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository:
#!/bin/bash

if test -z "$1"
then
echo "Usage: $0 <package> <version>"
exit 1
fi
package="$1"
version="$2"
if test "$version"
then
package="$package/version-$version"
fi
wget -qO - <nowiki>https://www.osselot.org/licenses.php?$package</nowiki>

If the script is called "getlicenses" and invoked for the software package that was used as example on the [[Search|search]] page as
getlicenses angular 15.2.2 | grep -v '^<'
the following list of licenses is returned:
Apache-2.0
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT
BSD-3-Clause
CC-BY-4.0
MIT
NOASSERTION
Public-domain
NOASSERTION

If the version number had been omitted, the licenses of all available versions would have been listed:
getlicenses angular | grep -v '^<'
angular/version-15.1.0:
Apache-2.0
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT
BSD-3-Clause
CC-BY-4.0
MIT
NOASSERTION
Public-domain
angular/version-15.2.2:
Apache-2.0
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT
BSD-3-Clause
CC-BY-4.0
MIT
NOASSERTION
Public-domain
angular/version-16.0.1:
Apache-2.0
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT
BSD-3-Clause
CC-BY-4.0
MIT
NOASSERTION
Public-domain
angular/version-16.1.2:
Apache-2.0
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT
BSD-3-Clause
CC-BY-4.0
MIT
NOASSERTION
Public-domain

Same as with the other Web scripts, the license URL can, of course, also be called directly in a browser such as https://www.osselot.org/licenses.php?angular.

==Web interface to immediately [[Search|search]] for a given package and provide a list of licenses==
<html>
<script src="/scripts/osadl.js">
</script>
<h4>Look for other 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 display the licenses that are used by a particular version</h4>

<input type="text" onkeyup="searchtextkeyup(event, this, 'licenses');" size="30" /><button onclick="searchOSSelot(this, 'licenses');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> list of concluded licenses</button><br />
<span style="display: none;"></span>
<br />

</html>

==Interface to obtain entire disclosure documents==
A similar interface provides for retrieving the [[Disclosure_files|entire disclosure files]] of particular software packages and versions instead of the licenses in use.

==Interface to obtain individually designed do-it-yourself disclosure documents==
A similar interface provides for obtaining [[DIY_Disclosure_files|individually designed do-it-yourself disclosure files]] with various ways to show licenses and add optional features.

Disclosure files

2023-10-06T20:40:50Z

CarstenEmde: Added link to interface for DIY disclosure documents

=Obtain disclosure files=
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface==
To download the 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 the following shell script can be used:
#!/bin/bash

if test -z "$1" -o -z "$2"
then
echo "Usage: $0 <package> <version>"
exit 1
fi
package="$1"
version="$2"
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`
then
wget -qO - <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/$package/version-$version/$package-$version-OSS-disclosure.txt</nowiki>
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.

If the script is called "getdisclosure" and invoked for the example that was used on the [[Search|search]] page as
getdisclosure angular 15.2.2
a text is returned that is ready to be used:
<html>
<script src="/scripts/osadl.js">
</script>
<button onmousemove="mousemove(event);" onclick="showdisclosure(this)">angular/15.2.2 disclosure material</button>
</html>
==Web interface to immediately [[Search|search]] for a given package and provide links to the disclosure documents of found package repositories==
<html>
<h4>Look for other 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 disclosure documents</h4>

<input type="text" onkeyup="searchtextkeyup(event, this, 'disclosure');" size="30" /><button onclick="searchOSSelot(this, 'disclosure');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> disclosure document</button><br />
<span style="display: none;"></span>
<br />

</html>

Material from multiple packages can each be given a title line and then concatenated.

==Interface to obtain individually designed do-it-yourself disclosure files==
A similar interface provides for obtaining [[DIY_Disclosure_files|individually designed do-it-yourself disclosure files]] with various ways to show licenses and add optional features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.

DIY Disclosure files

2023-10-06T20:35:49Z

CarstenEmde: Added link to interface for standard disclosure documents

=Create individually designed disclosure files=
<html>
<script src="/scripts/osadl.js">
</script>
<h5>Overall design</h5>
<input type="radio" id="none" name="licensing" checked="checked" value="-ln">
<label for="none"> Additional section with copyright notices per file</label><br>
<input type="radio" id="referenced" name="licensing" value="-lr">
<label for="referenced"> Same as first choice plus all licenses referenced</label><br>
<input type="radio" id="bsdtext" name="licensing" value="-lb">
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br>
<input type="radio" id="hashedtext" name="licensing" value="-lh">
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br>
<input type="radio" id="text" name="licensing" value="-lt">
<label for="text"> Same as first choice plus all licenses verbatim</label><br>
<h5>Additional features</h5>
<input type="checkbox" id="checksums" name="checksums">
<label for="checksums"> Checksums of files</label><br>
<input type="checkbox" id="numbered" name="numbered">
<label for="numbered"> Files numbered</label><br>
<input type="checkbox" id="preamble" name="preamble">
<label for="preamble"> Prepend preamble</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</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 />
<span style="display: none;"></span>
<br />

</html>

Material from multiple packages can each be given a title line and then concatenated.

==Interface to obtain standard disclosure documents==
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without an interface to select licensing and features.

==Interface to obtain a list of licenses==
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.