https://wiki.osselot.org/api.php?action=feedcontributions&feedformat=atom&user=WikiOSSelot - User contributions [en]2026-04-21T15:52:21ZUser contributionsMediaWiki 1.40.0https://wiki.osselot.org/index.php?title=Search&diff=250Search2025-06-19T13:01:02Z<p>Wiki: </p>
<hr />
<div>__NOTOC__<br />
=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
angular/version-16.2.0<br />
angular/version-17.1.3<br />
angular/version-19.1.6<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above described Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Look for other 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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<h4>Look for programs or libraries that are created by 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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repobin');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> resources such as [[Disclosure_files|disclosure documents]], [[DIY_Disclosure_files|individually designed disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=Search&diff=249Search2025-06-19T12:59:37Z<p>Wiki: </p>
<hr />
<div>__NOTOC__<br />
=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
angular/version-16.2.0<br />
angular/version-17.1.3<br />
angular/version-19.1.6<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above described Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Look for other 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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<h4>Look for programs or libraries that are created by 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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'binrepo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> resources such as [[Disclosure_files|disclosure documents]], [[DIY_Disclosure_files|individually designed disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=Search&diff=248Search2025-06-19T12:56:13Z<p>Wiki: Added search for binaries</p>
<hr />
<div>__NOTOC__<br />
=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above described Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Look for other 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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<h4>Look for programs or libraries that are created by 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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'binrepo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> resources such as [[Disclosure_files|disclosure documents]], [[DIY_Disclosure_files|individually designed disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=Imprint&diff=232Imprint2024-06-09T08:43:10Z<p>Wiki: Updated Chairman of the Supervisory Board and Board of Directors</p>
<hr />
<div>==Imprint according to § 5 TMG (German Telemedia Act)==<br />
<br />
Open Source Automation Development Lab (OSADL) eG<br />
Im Neuenheimer Feld 583<br />
69120 Heidelberg<br />
Germany<br />
<br />
Phone: +49 6221 98504-0<br />
<br />
VAT ID DE249975743<br />
<br />
Responsible editor: Dr. Carsten Emde<br />
<br />
Chairman of the Supervisory Board: Rainer Thieringer<br />
<br />
Board of Directors: Jan Altenberg, Caren Kresse<br />
<br />
Cooperative register number: 700048 at the District Court of Mannheim, Germany<br />
<br />
Auditing Association (Prüfungsverband):<br />
Baden-Württembergischer Genossenschaftsverband e.V.<br />
Heilbronner Straße 41<br />
70191 Stuttgart<br />
Germany</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=231DIY Disclosure files2024-03-09T12:56:19Z<p>Wiki: </p>
<hr />
<div>__NOTOC__<br />
=Create individually do-it-yourself designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
The calling convention of the URL is<br />
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki><br />
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.<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a particular package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of non-template BSD-type licenses</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include SHA256 checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><br />
<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><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Main_Page&diff=209Main Page2023-11-01T14:37:42Z<p>Wiki: Updated OSSelot logo to new font feature</p>
<hr />
<div>__NOTOC__<br />
== Welcome to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Wiki! ==<br />
<br />
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.<br />
<br />
==[[Search]] for a package==<br />
[[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.<br />
<br />
==Obtain [[Disclosure_files|disclosure files]]==<br />
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.<br />
<br />
==Create individually designed [[DIY_Disclosure_files|do-it-yourself disclosure files]]==<br />
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.<br />
<br />
==Obtain [[Licenses|licensing information]]== <br />
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.<br />
<br />
==Obtain curation data in various formats using a [[REST]] interface== <br />
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.<br />
<br />
==Reuse existing material in case of version mismatch==<br />
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].<br />
<br />
==Contributing to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project==<br />
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.<br />
<br />
==Best practices==<br />
====[[Curation guideline|How to curate data]]====<br />
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.<br />
<br />
==== [[SPDX2TV template]] ====<br />
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.<br />
<br />
====[[FOSSology]]====<br />
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.<br />
====[[Scancode]]====<br />
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.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=208DIY Disclosure files2023-10-24T04:40:07Z<p>Wiki: The updated "-c" option of the converter only enables SHA256 checksums</p>
<hr />
<div>__NOTOC__<br />
=Create individually do-it-yourself designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
The calling convention of the URL is<br />
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki><br />
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.<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of non-template BSD-type licenses</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include SHA256 checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=201DIY Disclosure files2023-10-08T13:08:01Z<p>Wiki: </p>
<hr />
<div>__NOTOC__<br />
=Create individually do-it-yourself designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
The calling convention of the URL is<br />
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki><br />
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.<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of non-template BSD-type licenses</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Search&diff=200Search2023-10-08T13:02:00Z<p>Wiki: Added link to individually designed disclosure documents</p>
<hr />
<div>__NOTOC__<br />
=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above described Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> resources such as [[Disclosure_files|disclosure documents]], [[DIY_Disclosure_files|individually designed disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=199DIY Disclosure files2023-10-08T12:58:45Z<p>Wiki: </p>
<hr />
<div>__NOTOC__<br />
=Create individually do-it-yourself designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
The calling convention of the URL is<br />
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki><br />
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.<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><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><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Main_Page&diff=198Main Page2023-10-08T12:58:11Z<p>Wiki: </p>
<hr />
<div>__NOTOC__<br />
== Welcome to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Wiki! ==<br />
<br />
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;">O</span> project], especially when accessing them in batch mode, e.g. as part of a software release build.<br />
<br />
==[[Search]] for a package==<br />
[[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;">O</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.<br />
<br />
==Obtain [[Disclosure_files|disclosure files]]==<br />
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.<br />
<br />
==Create individually designed [[DIY_Disclosure_files|do-it-yourself disclosure files]]==<br />
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.<br />
<br />
==Obtain [[Licenses|licensing information]]== <br />
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.<br />
<br />
==Obtain curation data in various formats using a [[REST]] interface== <br />
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.<br />
<br />
==Reuse existing material in case of version mismatch==<br />
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;">O</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;">O</span> presentations].<br />
<br />
==Contributing to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> project==<br />
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;">O</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;">O</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;">O</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;">O</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.<br />
<br />
==Best practices==<br />
====[[Curation guideline|How to curate data]]====<br />
High-quality curation data are the cornerstone of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</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;">O</span> project is given here to ensure consistency.<br />
<br />
==== [[SPDX2TV template]] ====<br />
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;">O</span> project and how they are interpreted.<br />
<br />
====[[FOSSology]]====<br />
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;">O</span> project (when re-using the data and also when contributing to the project), a number of conventions should be observed.<br />
====[[Scancode]]====<br />
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;">O</span> project.</div>Wikihttps://wiki.osselot.org/index.php?title=Licenses&diff=197Licenses2023-10-08T12:52:34Z<p>Wiki: Added __NOTOC__</p>
<hr />
<div>__NOTOC__<br />
=Obtain licenses=<br />
==Shell script==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test "$version"<br />
then<br />
package="$package/version-$version"<br />
fi<br />
wget -qO - <nowiki>https://www.osselot.org/licenses.php?$package</nowiki><br />
<br />
If the script is called "getlicenses" and invoked for the software package that was used as example on the [[Search|search]] page as<br />
getlicenses angular 15.2.2 | grep -v '^<'<br />
the following list of licenses is returned: <br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
NOASSERTION<br />
<br />
If the version number had been omitted, the licenses of all available versions would have been listed:<br />
getlicenses angular | grep -v '^<'<br />
angular/version-15.1.0:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-15.2.2:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-16.0.1:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-16.1.2:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
<br />
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.<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and provide a list of licenses==<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain entire disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|entire disclosure files]] of particular software packages and versions instead of the licenses in use.<br />
<br />
==Interface to obtain individually designed do-it-yourself disclosure documents==<br />
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.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=196DIY Disclosure files2023-10-08T12:51:54Z<p>Wiki: Added __NOTOC__</p>
<hr />
<div>__NOTOC__<br />
=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
The calling convention of the URL is<br />
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki><br />
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.<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><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><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Disclosure_files&diff=195Disclosure files2023-10-08T12:51:34Z<p>Wiki: Added __NOTOC__</p>
<hr />
<div>__NOTOC__<br />
=Obtain disclosure files=<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/$package/version-$version/$package-$version-OSS-disclosure.txt</nowiki><br />
fi<br />
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.<br />
<br />
If the script is called "getdisclosure" and invoked for the example that was used on the [[Search|search]] page as<br />
getdisclosure angular 15.2.2<br />
a text is returned that is ready to be used: <br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<button onmousemove="mousemove(event);" onclick="showdisclosure(this)">angular/15.2.2 disclosure material</button><br />
</div><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and provide links to the disclosure documents of found package repositories==<br />
<html><br />
<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><br />
<br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
Material from multiple packages can each be given a title line and then concatenated.<br />
<br />
==Interface to obtain individually designed do-it-yourself disclosure documents==<br />
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.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Search&diff=194Search2023-10-08T12:51:07Z<p>Wiki: Added __NOTOC__</p>
<hr />
<div>__NOTOC__<br />
=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above described Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> resources such as [[Disclosure_files|disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=193DIY Disclosure files2023-10-08T12:47:58Z<p>Wiki: Tried to improve some radio button labels and extended the explanation of access via browser</p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
The calling convention of the URL is<br />
<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki><br />
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.<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><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><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=192DIY Disclosure files2023-10-08T12:23:27Z<p>Wiki: Improved description of document formats, added radio button to fall back to unmodified SPDX standard</p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
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].<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="standard" name="licensing" value="standard"><br />
<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br><br />
<input type="radio" id="none" name="licensing" value="-ln"><br />
<label for="none"> Unreferenced licenses, then copyright notices by file</label><br><br />
<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr"><br />
<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Unreferenced licenses, then copyright notices and licenses by file, verbatim texts of non-template BSD-type licenses</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Unreferenced licenses, then copyright notices and licenses by file, verbatim texts of all non-template licenses</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Unreferenced licenses, then copyright notices and verbatim license texts by file</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=191DIY Disclosure files2023-10-07T19:58:20Z<p>Wiki: </p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
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].<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package to create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=190DIY Disclosure files2023-10-07T19:56:41Z<p>Wiki: </p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
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].<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=189DIY Disclosure files2023-10-07T19:52:29Z<p>Wiki: </p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
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].<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=188DIY Disclosure files2023-10-07T18:03:05Z<p>Wiki: </p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
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].<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=187DIY Disclosure files2023-10-07T17:54:01Z<p>Wiki: Made a number of corrections</p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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.<br />
===Call from browser===<br />
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].<br />
===Call from command line===<br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2" -o -z "$3" -o -z "$4"<br />
then<br />
echo "Usage: $0 <package> <version> <design> <features>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
design="$3"<br />
features="$4"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package/version-$version&$design&$features" | sed 's/<.*pre>//'</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=186DIY Disclosure files2023-10-07T17:21:19Z<p>Wiki: Added section on the technical background, but display it only on demand</p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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").<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package&-lr&-p"</nowiki><br />
fi<br />
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.<br />
<html><br />
</div><br />
<script src="/scripts/osadl.js"><br />
</script><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and create a disclosure document according to the given settings==<br />
<html><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Disclosure_files&diff=185Disclosure files2023-10-07T16:58:40Z<p>Wiki: </p>
<hr />
<div>=Obtain disclosure files=<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/$package/version-$version/$package-$version-OSS-disclosure.txt</nowiki><br />
fi<br />
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.<br />
<br />
If the script is called "getdisclosure" and invoked for the example that was used on the [[Search|search]] page as<br />
getdisclosure angular 15.2.2<br />
a text is returned that is ready to be used: <br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<button onmousemove="mousemove(event);" onclick="showdisclosure(this)">angular/15.2.2 disclosure material</button><br />
</div><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and provide links to the disclosure documents of found package repositories==<br />
<html><br />
<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><br />
<br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
Material from multiple packages can each be given a title line and then concatenated.<br />
<br />
==Interface to obtain individually designed do-it-yourself disclosure documents==<br />
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.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Licenses&diff=184Licenses2023-10-07T16:57:48Z<p>Wiki: </p>
<hr />
<div>=Obtain licenses=<br />
==Shell script==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test "$version"<br />
then<br />
package="$package/version-$version"<br />
fi<br />
wget -qO - <nowiki>https://www.osselot.org/licenses.php?$package</nowiki><br />
<br />
If the script is called "getlicenses" and invoked for the software package that was used as example on the [[Search|search]] page as<br />
getlicenses angular 15.2.2 | grep -v '^<'<br />
the following list of licenses is returned: <br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
NOASSERTION<br />
<br />
If the version number had been omitted, the licenses of all available versions would have been listed:<br />
getlicenses angular | grep -v '^<'<br />
angular/version-15.1.0:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-15.2.2:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-16.0.1:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-16.1.2:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
<br />
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.<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately use the above described script and [[Search|search]] for a given package and provide a list of licenses==<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain entire disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|entire disclosure files]] of particular software packages and versions instead of the licenses in use.<br />
<br />
==Interface to obtain individually designed do-it-yourself disclosure documents==<br />
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.</div>Wikihttps://wiki.osselot.org/index.php?title=Licenses&diff=183Licenses2023-10-07T16:57:01Z<p>Wiki: Added button to display the technical background information only on demand</p>
<hr />
<div>=Obtain licenses=<br />
==Shell script==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test "$version"<br />
then<br />
package="$package/version-$version"<br />
fi<br />
wget -qO - <nowiki>https://www.osselot.org/licenses.php?$package</nowiki><br />
<br />
If the script is called "getlicenses" and invoked for the software package that was used as example on the [[Search|search]] page as<br />
getlicenses angular 15.2.2 | grep -v '^<'<br />
the following list of licenses is returned: <br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
NOASSERTION<br />
<br />
If the version number had been omitted, the licenses of all available versions would have been listed:<br />
getlicenses angular | grep -v '^<'<br />
angular/version-15.1.0:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-15.2.2:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-16.0.1:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
angular/version-16.1.2:<br />
Apache-2.0<br />
Apache-2.0 AND 0BSD AND BSD-2-Clause AND BSD-3-Clause AND BSD-3-Clause-Salesforce AND ISC AND MIT<br />
BSD-3-Clause<br />
CC-BY-4.0<br />
MIT<br />
NOASSERTION<br />
Public-domain<br />
<br />
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.<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately [[Search|search]] for a given package and provide a list of licenses==<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain entire disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|entire disclosure files]] of particular software packages and versions instead of the licenses in use.<br />
<br />
==Interface to obtain individually designed do-it-yourself disclosure documents==<br />
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.</div>Wikihttps://wiki.osselot.org/index.php?title=Disclosure_files&diff=182Disclosure files2023-10-07T16:55:27Z<p>Wiki: Added button to display the technical background information only on demand</p>
<hr />
<div>=Obtain disclosure files=<br />
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
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:<br />
#!/bin/bash<br />
<br />
if test -z "$1" -o -z "$2"<br />
then<br />
echo "Usage: $0 <package> <version>"<br />
exit 1<br />
fi<br />
package="$1"<br />
version="$2"<br />
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`<br />
then<br />
wget -qO - <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/$package/version-$version/$package-$version-OSS-disclosure.txt</nowiki><br />
fi<br />
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.<br />
<br />
If the script is called "getdisclosure" and invoked for the example that was used on the [[Search|search]] page as<br />
getdisclosure angular 15.2.2<br />
a text is returned that is ready to be used: <br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<button onmousemove="mousemove(event);" onclick="showdisclosure(this)">angular/15.2.2 disclosure material</button><br />
</div><br />
</html><br />
==Web interface to immediately [[Search|search]] for a given package and provide links to the disclosure documents of found package repositories==<br />
<html><br />
<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><br />
<br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
Material from multiple packages can each be given a title line and then concatenated.<br />
<br />
==Interface to obtain individually designed do-it-yourself disclosure documents==<br />
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.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=Search&diff=181Search2023-10-07T16:52:45Z<p>Wiki: </p>
<hr />
<div>=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above described Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> resources such as [[Disclosure_files|disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=Search&diff=180Search2023-10-07T16:52:10Z<p>Wiki: Added button to display the technical background information only on demand</p>
<hr />
<div>=About searching=<br />
This page provides information how to use a Web script to find out whether a particular software package and optionally in a particular version already has been curated. It can be used to create references into the particular <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository on Github as exemplified [[Disclosure_files|here]].<br />
<br />
==Find out whether a particular version of a software package is supported and has already been curated==<br />
<html><br />
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /><br />
<div id="showondemand" style="display: none;"><br />
</html><br />
For this purpose a special Web script is provided at the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Web interface.<br />
<br />
===Call the Web script from browser===<br />
Use the URL '''''<nowiki>https://www.osselot.org/curated.php?packagename</nowiki>''''' to determine whether a particular software package already has been curated and, if so, for which version disclosure information is available. For example https://www.osselot.org/curated.php?angular may return <br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
If a package has not been curated so far, the output of the given URL remains empty. Otherwise, the output can be concatenated to the URL of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github package repository at '''''<nowiki>https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/</nowiki>''''' such as, for example,<br />
<br />
https://github.com/Open-Source-Compliance/package-analysis/tree/main/analysed-packages/angular/version-15.2.2<br />
<br />
===Call the Web script from command line===<br />
====Checkout any versions====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep -v '<'<br />
angular/version-15.1.0<br />
angular/version-15.2.2<br />
angular/version-16.0.1<br />
angular/version-16.1.2<br />
<br />
====Search for a particular version====<br />
wget -qO - https://www.osselot.org/curated.php?angular | grep 15.2.2<br />
angular/version-15.2.2<br />
<br />
<html><br />
</div><br />
</html><br />
==Web interface to immediately run the above Web script from this page and provide links to the found repositories==<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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 repositories</h4><br />
<br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'repo');" size="30" /><button onclick="searchOSSelot(this, 'repo');">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
==Web interfaces to extract particular information==<br />
The above Web script may be encapsulated in a shell script to extract particular information from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> resources such as [[Disclosure_files|disclosure documents]] or [[Licenses|list of licenses in use]].</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=179DIY Disclosure files2023-10-07T11:36:02Z<p>Wiki: </p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=DIY_Disclosure_files&diff=178DIY Disclosure files2023-10-07T08:02:22Z<p>Wiki: Added link to SPDX2Disclosure repo and applied some minor modifications</p>
<hr />
<div>=Create individually designed disclosure files=<br />
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h5>Overall design</h5><br />
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"><br />
<label for="none"> Additional section with copyright notices per file</label><br><br />
<input type="radio" id="referenced" name="licensing" value="-lr"><br />
<label for="referenced"> Same as first choice plus all licenses referenced</label><br><br />
<input type="radio" id="bsdtext" name="licensing" value="-lb"><br />
<label for="bsdtext"> Same as first choice plus non-standard BSD licenses verbatim</label><br><br />
<input type="radio" id="hashedtext" name="licensing" value="-lh"><br />
<label for="hashedtext"> Same as first choice plus all hashed licenses verbatim</label><br><br />
<input type="radio" id="text" name="licensing" value="-lt"><br />
<label for="text"> Same as first choice plus all licenses verbatim</label><br><br />
<h5>Additional features</h5><br />
<input type="checkbox" id="checksums" name="checksums"><br />
<label for="checksums"> Include file checksums</label><br><br />
<input type="checkbox" id="numbered" name="numbered"><br />
<label for="numbered"> Number files consecutively</label><br><br />
<input type="checkbox" id="preamble" name="preamble"><br />
<label for="preamble"> Prepend package information</label><br><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><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;">O</span> disclosure document</button><br /><br />
<span style="display: none;"></span><br />
<br /><br />
<br />
</html><br />
<br />
==Interface to obtain standard disclosure documents==<br />
A similar interface provides for retrieving the [[Disclosure_files|standard disclosure files]] without an interface for selecting the overall design for inclusion of licensing data and for adding certain optional features.<br />
<br />
==Interface to obtain a list of licenses==<br />
A similar interface provides for listing the [[Licenses|licenses]] that a particular software package uses instead of the entire disclosure documents.</div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=151JSON2023-08-03T05:44:22Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<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 /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
<html><br />
<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><br />
<i>(Also same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=149JSON2023-07-31T10:09:54Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>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><br />
<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 /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
<html><br />
<h4>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><br />
<i>(Also same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=148JSON2023-07-30T15:54:29Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>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><br />
<i>(Same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
<html><br />
<h4>Search for a package, select it, validate the JSON formatted data for syntax correctness and display the result in a new window</h4><br />
<i>(Same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=147JSON2023-07-30T15:52:39Z<p>Wiki: Added search box for JSON validator</p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>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><br />
<i>(Same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
<html><br />
<h4>Search for a package, select it, validate the JSON formatted data for syntax correctness and display the result in a new window</h4><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=YAML&diff=146YAML2023-07-28T20:43:19Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in YAML format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in YAML format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/yaml/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/yaml/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/yaml/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format YAML text file in browser====<br />
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as<br />
<html><br />
<a href="https://www.osselot.org:3263/yaml/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=SPDX2TV&diff=145SPDX2TV2023-07-28T20:42:44Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in SPDX2TV format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in SPDX2TV format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/spdx/<package>/<version><br />
</pre><br />
<pre><br />
https://www.osselot.org:3263/spdx/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/spdx/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format SPDX2TV text file in browser====<br />
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as<br />
<html><br />
<a href="https://www.osselot.org:3263/spdx/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=144JSON2023-07-28T20:42:08Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>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><br />
<i>(Same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=RDF-XML&diff=143RDF-XML2023-07-28T20:40:38Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in RDF-XML format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in RDF-XML format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/xml/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/xml/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/xml/busybox/1.35.0<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format YAML text file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/xml/busybox/1.35.0">BusyBox version 1.35.0</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
<html><br />
<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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=RDF-XML&diff=142RDF-XML2023-07-28T20:34:15Z<p>Wiki: Added W3C RDF validation service</p>
<hr />
<div>==Obtain curation data in RDF-XML format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in RDF-XML format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/xml/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/xml/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/xml/busybox/1.35.0<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format YAML text file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/xml/busybox/1.35.0">BusyBox version 1.35.0</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Search for a package, 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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html><br />
<br />
<html><br />
<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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=141JSON2023-07-28T14:22:59Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Use the below search box to immediately test 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><br />
<i>(Same as above, some of the packages may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=REST&diff=140REST2023-07-27T17:53:27Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data via a REST interface==<br />
====Available formats====<br />
Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.<br />
====Scheme====<br />
This REST interface uses HTTP protocol at port 3262 and the following scheme:<br />
<pre><br />
http://www.osselot.org:3262/<format>/<package>/<version><br />
</pre><br />
Alternatively and if needed, the SSL-enabled port 3263 can be used in which case the scheme has the form<br />
<pre><br />
https://www.osselot.org:3263/<format>/<package>/<version><br />
</pre><br />
where <format> may be any of "json", "spdx", "xml" or "yaml". The version must be given when [[RDF-XML]], [[SPDX2TV]] or [[YAML]] format is used. Only [[JSON]] format permits to retrieve all curated versions of a software package with a single REST call.<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4 style="padding-bottom: 8px;">Use the below select box and search field to define a data format and enter the name of a software package. Then select one of the available software versions to immediately run the REST interface for the given package and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4><br />
<span><label for="formats">Format: </label><br />
<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats"><br />
<option value="json" selected="selected">JSON</option><br />
<option value="xml">RDF-XML</option><br />
<option value="spdx">SPDX2TV</option><br />
<option value="yaml">YAML</option><br />
</select><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" /><br />
<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
</span><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=REST&diff=139REST2023-07-27T16:25:12Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data via a REST interface==<br />
====Available formats====<br />
Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.<br />
====Scheme====<br />
This REST interface uses HTTP protocol at port 3262 and the following scheme:<br />
<pre><br />
http://www.osselot.org:3262/<format>/<package>/<version><br />
</pre><br />
Alternatively and if needed, the SSL-enabled port 3263 can be used in which case the scheme has the form<br />
<pre><br />
https://www.osselot.org:3263/<format>/<package>/<version><br />
</pre><br />
where <format> may be any of "json", "spdx", "xml" or "yaml". The version must be given when [[RDF-XML]], [[SPDX2TV]] or [[YAML]] format is used. Only [[JSON]] format permits to retrieve all curated versions of a software package with a single REST call.<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<script><br />
function onselectchange(select, link)<br />
{<br />
button = select.nextElementSibling.nextElementSibling;<br />
if (button.nextElementSibling.nextElementSibling.style.display != "none")<br />
searchOSSelot(button, link);<br />
}<br />
</script><br />
<h4 style="padding-bottom: 8px;">Use the below select box and search field to define a data format and enter the name of a software package. Then select one of the available software versions to immediately run the REST interface for the given package and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4><br />
<span><label for="formats">Format: </label><br />
<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats"><br />
<option value="json" selected="selected">JSON</option><br />
<option value="xml">RDF-XML</option><br />
<option value="spdx">SPDX2TV</option><br />
<option value="yaml">YAML</option><br />
</select><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" /><br />
<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
</span><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=REST&diff=138REST2023-07-27T16:13:39Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data via a REST interface==<br />
====Available formats====<br />
Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.<br />
====Scheme====<br />
This REST interface uses HTTP protocol at port 3262 and the following scheme:<br />
<pre><br />
http://www.osselot.org:3262/<format>/<package>/<version><br />
</pre><br />
Alternatively and if needed, the SSL-enabled port 3263 can be used in which case the scheme has the form<br />
<pre><br />
https://www.osselot.org:3263/<format>/<package>/<version><br />
</pre><br />
where <format> may be any of "json", "spdx", "xml" or "yaml". The version must be given when [[RDF-XML]], [[SPDX2TV]] or [[YAML]] format is used. Only [[JSON]] format permits to retrieve all curated versions of a software package with a single REST call.<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<script><br />
function onselectchange(select, link)<br />
{<br />
searchOSSelot(select.nextElementSibling.nextElementSibling, link);<br />
}<br />
</script><br />
<h4 style="padding-bottom: 8px;">Use the below select box and search field to define a data format and enter the name of a software package. Then select one of the available software versions to immediately run the REST interface for the given package and display the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4><br />
<span><label for="formats">Format: </label><br />
<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats"><br />
<option value="json" selected="selected">JSON</option><br />
<option value="xml">RDF-XML</option><br />
<option value="spdx">SPDX2TV</option><br />
<option value="yaml">YAML</option><br />
</select><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" /><br />
<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
</span><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=REST&diff=137REST2023-07-27T16:05:21Z<p>Wiki: Added search box</p>
<hr />
<div>==Obtain curation data via a REST interface==<br />
====Available formats====<br />
Currently, the curated data are available in [[JSON]], [[RDF-XML]], [[SPDX2TV]] and [[YAML]] format.<br />
====Scheme====<br />
This REST interface uses HTTP protocol at port 3262 and the following scheme:<br />
<pre><br />
http://www.osselot.org:3262/<format>/<package>/<version><br />
</pre><br />
Alternatively and if needed, the SSL-enabled port 3263 can be used in which case the scheme has the form<br />
<pre><br />
https://www.osselot.org:3263/<format>/<package>/<version><br />
</pre><br />
where <format> may be any of "json", "spdx", "xml" or "yaml". The version must be given when [[RDF-XML]], [[SPDX2TV]] or [[YAML]] format is used. Only [[JSON]] format permits to retrieve all curated versions of a software package with a single REST call.<br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<script><br />
function onselectchange(select, link)<br />
{<br />
searchOSSelot(select.nextElementSibling.nextElementSibling, link);<br />
}<br />
</script><br />
<h4>Use the below search box to immediately test the REST interface for the available data formats and display the selected <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> curation data in a new window</h4><br />
<span><label for="formats">Format: </label><br />
<select onchange="onselectchange(this, 'rest' + document.getElementById('formats').value);" name="formats" id="formats"><br />
<option value="json" selected="selected">JSON</option><br />
<option value="xml">RDF-XML</option><br />
<option value="spdx">SPDX2TV</option><br />
<option value="yaml">YAML</option><br />
</select><br />
<input type="text" onkeyup="searchtextkeyup(event, this, 'rest' + document.getElementById('formats').value);" size="30" /><br />
<button onclick="searchOSSelot(this, 'rest' + document.getElementById('formats').value);">Search the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> repository</button><br /><br />
<span style="display: none;"></span><br />
</span><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=YAML&diff=136YAML2023-07-27T09:55:31Z<p>Wiki: Added search box</p>
<hr />
<div>==Obtain curation data in YAML format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in YAML format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/yaml/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/yaml/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/yaml/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format YAML text file in browser====<br />
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as<br />
<html><br />
<a href="https://www.osselot.org:3263/yaml/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Use the below search box to immediately test 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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=SPDX2TV&diff=135SPDX2TV2023-07-27T09:53:23Z<p>Wiki: Added search box</p>
<hr />
<div>==Obtain curation data in SPDX2TV format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in SPDX2TV format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/spdx/<package>/<version><br />
</pre><br />
<pre><br />
https://www.osselot.org:3263/spdx/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/spdx/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format SPDX2TV text file in browser====<br />
The curated data of a single version of a curated software package may be displayed in plain text format in a browser such as<br />
<html><br />
<a href="https://www.osselot.org:3263/spdx/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Use the below search box to immediately test 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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=RDF-XML&diff=134RDF-XML2023-07-27T09:52:12Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in RDF-XML format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in RDF-XML format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/xml/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/xml/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/xml/busybox/1.35.0<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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.<br />
<br />
====Format YAML text file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/xml/busybox/1.35.0">BusyBox version 1.35.0</a><br />
</html><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Use the below search box to immediately test 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><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=133JSON2023-07-27T09:50:34Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Use the below search box to immediately test 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><br />
<i>(Same as above, this may take a long time to render.)</i><br /><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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wikihttps://wiki.osselot.org/index.php?title=JSON&diff=132JSON2023-07-27T09:49:38Z<p>Wiki: </p>
<hr />
<div>==Obtain curation data in JSON format==<br />
====Single version====<br />
To obtain curation data of a single version of a software package in JSON format, the following [[REST]] calls may be used:<br />
<pre><br />
http://www.osselot.org:3262/json/<package>/<version><br />
</pre><br />
or<br />
<pre><br />
https://www.osselot.org:3263/json/<package>/<version><br />
</pre><br />
such as in a <i>wget</i> command<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://www.osselot.org:3262/json/dbus/1.15.2<br />
</syntaxhighlight><br />
<br />
====All available versions of a software package====<br />
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<br />
<syntaxhighlight lang="bash"><br />
wget -qO - http://wwww.osselot.org:3262/json/dbus<br />
</syntaxhighlight><br />
<br />
====Format JSON file in browser====<br />
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<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus/1.15.2">DBus version 1.15.2</a><br />
</html><br />
or even<br />
<html><br />
<a href="https://www.osselot.org:3263/json/dbus">all curated versions of DBus</a>.<br />
</html><br />
<br />
<i>(Please note that the above browser commands, particularly the second, may take a long time to render.)</i><br />
<br />
<html><br />
<script src="/scripts/osadl.js"><br />
</script><br />
<h4>Use the below search box to immediately test 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><br />
<i>(Same as above, this may take a long time to render.)</i><br />
<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 /><br />
<span style="display: none;"></span><br />
<br /><br />
</html></div>Wiki