Main Page: Difference between revisions

From OSSelot
Jump to navigation Jump to search
No edit summary
(Added more detailed information to the first three sections)
Line 3: Line 3:
This Wiki was created to facilitate the daily work with the resources of the [https://www.osselot.org OSSelot project].
This Wiki was created to facilitate the daily work with the resources of the [https://www.osselot.org OSSelot project].


* How do I use the disclosure files if my software package is already included in the current version of OSSelot?
=== First step: Find out whether a particular version of a software package is supported by OSSelot and has already been curated. ===
* How do I use the disclosure files if my software package is included with OSSelot but in a different version?
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 returns
* How do I contribute to OSSelot if I have curated a package not yet included with OSSelot in this version?
angular/version-15.1.0
angular/version-15.2.2
angular/version-16.0.1
angular/version-16.1.2
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 the base URL of the raw content of the OSSelot Github repository <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/</nowiki> such as, for example,
 
https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/angular/version-15.2.2
 
=== Next step: How do I obtain the disclosure file if my software package is already included in the current version of OSSelot? ===
To download the disclosure file that relates to a given package name and version from the OSSelot Github repository the following script can be used:
#!/bin/bash
package="$1"
version="$2"
if test -z "$1" -o -z "$2"
then
  echo "Usage: $0 <package> <version>"
  exit 1
fi
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version`
then
  wget -qO - <nowiki>https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/$package/version-$version/$package-$version-OSS-disclosure.txt</nowiki>
fi
The output of this script can then be copied into the material accompanying the distribution of the corresponding software package and given to the recipient of the software upon delivery as an important step towards compliance with the license terms.
 
=== Alternatively: How do I use the disclosure files if my software package is included in OSSelot but in a different version? ===
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 OSSelot home page: Please check out "Use case 2" at https://www.osselot.org/index.php?s=presentations
 
=== By the way: How do I contribute to OSSelot if I have curated a package not yet included with OSSelot in this version? ===

Revision as of 18:28, 7 July 2023

Welcome to the OSSelot Wiki!

This Wiki was created to facilitate the daily work with the resources of the OSSelot project.

First step: Find out whether a particular version of a software package is supported by OSSelot and has already been curated.

Use the URL https://www.osselot.org/curated.php?packagename 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 returns

angular/version-15.1.0
angular/version-15.2.2
angular/version-16.0.1
angular/version-16.1.2

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 the base URL of the raw content of the OSSelot Github repository https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/ such as, for example,

https://raw.githubusercontent.com/Open-Source-Compliance/package-analysis/main/analysed-packages/angular/version-15.2.2

Next step: How do I obtain the disclosure file if my software package is already included in the current version of OSSelot?

To download the disclosure file that relates to a given package name and version from the OSSelot Github repository the following script can be used:

#!/bin/bash

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

The output of this script can then be copied into the material accompanying the distribution of the corresponding software package and given to the recipient of the software upon delivery as an important step towards compliance with the license terms.

Alternatively: How do I use the disclosure files if my software package is included in OSSelot but in a different version?

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 OSSelot home page: Please check out "Use case 2" at https://www.osselot.org/index.php?s=presentations

By the way: How do I contribute to OSSelot if I have curated a package not yet included with OSSelot in this version?