Main Page - Revision history

CarstenEmde: Added secstion on large repository files

2025-06-12T22:48:43Z

Added secstion on large repository files

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

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

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

CarstenEmde: Added section on callgraphs with link to a newly created page

2025-03-05T18:33:16Z

Added section on callgraphs with link to a newly created page

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

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

	==Obtain [[Disclosure_files\|disclosure files]]==		==Obtain [[Disclosure_files\|disclosure files]]==

Wiki: Updated OSSelot logo to new font feature

2023-11-01T14:37:42Z

Updated OSSelot logo to new font feature

Wiki at 12:58, 8 October 2023

2023-10-08T12:58:11Z

← Older revision		Revision as of 14:58, 8 October 2023
Line 10:		Line 10:
	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.		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.

	==~~Obtain~~ individually designed [[DIY_Disclosure_files\|do-it-yourself disclosure files]]==		==Create individually designed [[DIY_Disclosure_files\|do-it-yourself disclosure files]]==
	Define a set of custom characteristics of what the disclosure file should look like, search for a package and create a custom disclosure file for it.		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.

CarstenEmde: Added Link to DIY disclosure generator

2023-10-06T18:10:20Z

Added Link to DIY disclosure generator

← Older revision		Revision as of 20:10, 6 October 2023
Line 9:		Line 9:
	==Obtain [[Disclosure_files\|disclosure files]]==		==Obtain [[Disclosure_files\|disclosure files]]==
	A shell script is provided to encapsulate the [[Search\|Web search script]] and obtain the related disclosure files. Another interactive Web interface is available to test and use this feature.		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.

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

	==Obtain [[Licenses\|licensing information]]==		==Obtain [[Licenses\|licensing information]]==

CarstenEmde at 07:41, 7 August 2023

2023-08-07T07:41:31Z

← Older revision		Revision as of 09:41, 7 August 2023
Line 13:		Line 13:
	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.		Another Web script is available that also encapsulates the internal algorithm of the [[Search\|Web search script]], but then generates a list of licenses that are used in a given software package. The script accepts as argument either a package name or a package name along with a version. In the former case the licenses of all available versions are listed, whereas in the latter the output is restricted to the specified version.

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

Ckresse: Add "SPDX2TV template" introduction

2023-08-03T08:57:17Z

Add "SPDX2TV template" introduction

← Older revision		Revision as of 10:57, 3 August 2023
Line 23:		Line 23:

	==Best practices==		==Best practices==
	====FOSSology====		====[[Curation guideline\|How to curate data]]====
			High-quality curation data are the cornerstone of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">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.

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

			====[[FOSSology]]====
	In order to use the [[FOSSology]] Open Source curation administration tool in connection with the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> project (when re-using the data and also when contributing to the project), a number of conventions should be observed.		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.
	====Scancode====		====[[Scancode]]====
	Normally, the [[Scancode]] Open Source scanning tool is used under the control of [[FOSSology]] in this project; however, to fine-tune or confirm the results it may be necessary to run the tool separately from command line. If this is done, the command line options should match the conventions of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> project.		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.
	~~====How to curate data====~~
	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.

Ckresse at 06:27, 3 August 2023

2023-08-03T06:27:39Z

← Older revision		Revision as of 08:27, 3 August 2023
Line 28:		Line 28:
	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.		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.
	====How to curate data====		====How to curate data====
	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 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.		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.

Ckresse: Add "How to curate data" section introduction.

2023-08-03T06:24:46Z

Add "How to curate data" section introduction.

← Older revision		Revision as of 08:24, 3 August 2023
Line 27:		Line 27:
	====Scancode====		====Scancode====
	Normally, the [[Scancode]] Open Source scanning tool is used under the control of [[FOSSology]] in this project; however, to fine-tune or confirm the results it may be necessary to run the tool separately from command line. If this is done, the command line options should match the conventions of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> project.		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.
			====How to curate data====
			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 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.

Wiki at 23:13, 26 July 2023

2023-07-26T23:13:18Z

← Older revision		Revision as of 01:13, 27 July 2023
Line 14:		Line 14:

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

	==Reuse existing material in case of version mismatch==		==Reuse existing material in case of version mismatch==

← Older revision		Revision as of 20:10, 6 October 2023
Line 9:		Line 9:
	==Obtain [[Disclosure_files\|disclosure files]]==		==Obtain [[Disclosure_files\|disclosure files]]==
	A shell script is provided to encapsulate the [[Search\|Web search script]] and obtain the related disclosure files. Another interactive Web interface is available to test and use this feature.		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.

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

	==Obtain [[Licenses\|licensing information]]==		==Obtain [[Licenses\|licensing information]]==

← Older revision		Revision as of 16:37, 1 November 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	== Welcome to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Wiki! ==		== Welcome to the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Wiki! ==

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

	==[[Search]] for a package==		==[[Search]] for a package==
	[[Search\|Find out]] whether a particular version of a software package is supported by <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">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.		[[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.

	==Obtain [[Disclosure_files\|disclosure files]]==		==Obtain [[Disclosure_files\|disclosure files]]==
Line 20:		Line 20:

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

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

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

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

	====[[FOSSology]]====		====[[FOSSology]]====
	In order to use the [[FOSSology]] Open Source curation administration tool in connection with the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> project (when re-using the data and also when contributing to the project), a number of conventions should be observed.		In order to use the [[FOSSology]] Open Source curation administration tool in connection with the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> project (when re-using the data and also when contributing to the project), a number of conventions should be observed.
	====[[Scancode]]====		====[[Scancode]]====
	Normally, the [[Scancode]] Open Source scanning tool is used under the control of [[FOSSology]] in this project; however, to fine-tune or confirm the results it may be necessary to run the tool separately from command line. If this is done, the command line options should match the conventions of the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> project.		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.