Dashboard UI for the Code Scanner (GSoC task) - Revision history

KShivendu: Add KShivendu

2022-03-11T06:41:55Z

Add KShivendu

← Older revision		Revision as of 06:41, 11 March 2022
Line 38:		Line 38:

	* Stefano Zacchiroli <zack@upsilon.cc> (zack on [[IRC]])		* Stefano Zacchiroli <zack@upsilon.cc> (zack on [[IRC]])
			* Kumar Shivendu (KShivendu on [[IRC]])

	[[Category:Available GSoC task]]		[[Category:Available GSoC task]]
	[[Category:GSoC task]]		[[Category:GSoC task]]

StefanoZacchiroli: /* Task description */

2022-02-25T09:56:00Z

Task description

← Older revision		Revision as of 09:56, 25 February 2022
Line 24:		Line 24:
	* Paper cuts: [https://forge.softwareheritage.org/tag/code_scanner/ various issues] affect the usability of swh-scanner, improving them would be welcome as part of this project		* Paper cuts: [https://forge.softwareheritage.org/tag/code_scanner/ various issues] affect the usability of swh-scanner, improving them would be welcome as part of this project

	Expected duration: 350 hours. Difficulty: medium		=== Expected duration ===

			350 hours. Difficulty: medium

	== Desirable skills ==		== Desirable skills ==

Vlorentz: /* Task description */

2022-02-25T07:14:37Z

Task description

← Older revision		Revision as of 07:14, 25 February 2022
Line 23:		Line 23:
	* Functionality: in the future additional information will be added to scanning results, including license and provenance information. While not yet available right now due to backend limitations, the proposed UI should plan ahead about how/where to display such information		* Functionality: in the future additional information will be added to scanning results, including license and provenance information. While not yet available right now due to backend limitations, the proposed UI should plan ahead about how/where to display such information
	* Paper cuts: [https://forge.softwareheritage.org/tag/code_scanner/ various issues] affect the usability of swh-scanner, improving them would be welcome as part of this project		* Paper cuts: [https://forge.softwareheritage.org/tag/code_scanner/ various issues] affect the usability of swh-scanner, improving them would be welcome as part of this project

			Expected duration: 350 hours. Difficulty: medium

	== Desirable skills ==		== Desirable skills ==

StefanoZacchiroli: add link to zack swh-scanner talk in 2021

2022-02-13T16:36:49Z

add link to zack swh-scanner talk in 2021

← Older revision		Revision as of 16:36, 13 February 2022
Line 5:		Line 5:
	As such, it can be used to scan local source code bases to detect which parts of it come from public code, including Free and Open Source Software.		As such, it can be used to scan local source code bases to detect which parts of it come from public code, including Free and Open Source Software.

	The Software Heritage scanner (<code>swh-scanner</code>) ([https://docs.softwareheritage.org/devel/swh-scanner/ documentation], [https://forge.softwareheritage.org/source/swh-scanner/ code]) is a command line tool that enables doing that.		The Software Heritage scanner (<code>swh-scanner</code>) ([https://docs.softwareheritage.org/devel/swh-scanner/ documentation], [https://forge.softwareheritage.org/source/swh-scanner/ code], [https://upsilon.cc/~zack/talks/2021/2021-04-07-llw.pdf slides of a 2021 presentation about swh-scanner]) is a command line tool that enables doing that.

	== Task description ==		== Task description ==

StefanoZacchiroli: add pointer to swh-scanner open tasks

2022-02-13T16:35:06Z

add pointer to swh-scanner open tasks

← Older revision		Revision as of 16:35, 13 February 2022
Line 18:		Line 18:
	The following improvements are suggested, although more can be proposed (and even more could be discovered during the project work):		The following improvements are suggested, although more can be proposed (and even more could be discovered during the project work):

	* ~~technology~~: generating a local HTML file is not necessarily the best way to render results, alternative solutions should be explored, including a self-hosted web app, rendering results with state-of-the-art frontend web frameworks (css/html/javascript)		* Technology: generating a local HTML file is not necessarily the best way to render results, alternative solutions should be explored, including a self-hosted web app, rendering results with state-of-the-art frontend web frameworks (css/html/javascript)
	* ~~scalability~~: currently rendering doesn't work when scanning large code bases such as the Linux kernel, rendering should be made lazy, by only loading data to show when needed		* Scalability: currently rendering doesn't work when scanning large code bases such as the Linux kernel, rendering should be made lazy, by only loading data to show when needed
	* ~~functionality~~: dashboard rendering should be integrated with the possibility of opening the local source code files that have been scanned, e.g., users will want to be able to open in-browser files that have been detected as known/unknown, in order to figure why		* Functionality: dashboard rendering should be integrated with the possibility of opening the local source code files that have been scanned, e.g., users will want to be able to open in-browser files that have been detected as known/unknown, in order to figure why
	* ~~functionality~~: in the future additional information will be added to scanning results, including license and provenance information. While not yet available right now due to backend limitations, the proposed UI should plan ahead about how/where to display such information		* Functionality: in the future additional information will be added to scanning results, including license and provenance information. While not yet available right now due to backend limitations, the proposed UI should plan ahead about how/where to display such information
			* Paper cuts: [https://forge.softwareheritage.org/tag/code_scanner/ various issues] affect the usability of swh-scanner, improving them would be welcome as part of this project

	== Desirable skills ==		== Desirable skills ==
Line 28:		Line 29:
	* Basic understanding of the Software Heritage [https://docs.softwareheritage.org/devel/swh-model/data-model.html data model] and of [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html SWHID identifiers]		* Basic understanding of the Software Heritage [https://docs.softwareheritage.org/devel/swh-model/data-model.html data model] and of [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html SWHID identifiers]
	* HTML/CSS/JavaScript and web development in general		* HTML/CSS/JavaScript and web development in general
	* ~~working~~ knowledge of UI/UX design principles		* Working knowledge of UI/UX design principles

	== Potential mentors ==		== Potential mentors ==

StefanoZacchiroli: create gsoc task

2022-02-13T16:30:12Z

create gsoc task

New page

== Introduction ==

The Software Heritage archive is the most comprehensive open data knowledge base about source code that has been published openly.

As such, it can be used to scan local source code bases to detect which parts of it come from public code, including Free and Open Source Software.

The Software Heritage scanner (<code>swh-scanner</code>) ([https://docs.softwareheritage.org/devel/swh-scanner/ documentation], [https://forge.softwareheritage.org/source/swh-scanner/ code]) is a command line tool that enables doing that.

== Task description ==

<code>swh-scanner</code> is currently an experimental tool, which works well in practice, but need a real '''dashboard user interface''' to be useful.
Several output options are currently available when invoking the <code>swh scanner scan</code> command, in particular batch output in textual and JSON format, and an interactive
dashboard (with the <code>-i/--interactive</code>) option.

The interactive view currently works by producing a local HTML file and opening it using the local browser.
The goal of this project is to '''improve the interactive view''', making it a serious dashboard-style UI to peruse scanning results.

The following improvements are suggested, although more can be proposed (and even more could be discovered during the project work):

* technology: generating a local HTML file is not necessarily the best way to render results, alternative solutions should be explored, including a self-hosted web app, rendering results with state-of-the-art frontend web frameworks (css/html/javascript)
* scalability: currently rendering doesn't work when scanning large code bases such as the Linux kernel, rendering should be made lazy, by only loading data to show when needed
* functionality: dashboard rendering should be integrated with the possibility of opening the local source code files that have been scanned, e.g., users will want to be able to open in-browser files that have been detected as known/unknown, in order to figure why
* functionality: in the future additional information will be added to scanning results, including license and provenance information. While not yet available right now due to backend limitations, the proposed UI should plan ahead about how/where to display such information

== Desirable skills ==

* Python 3 and Git are a must to work on any Software Heritage project
* Basic understanding of the Software Heritage [https://docs.softwareheritage.org/devel/swh-model/data-model.html data model] and of [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html SWHID identifiers]
* HTML/CSS/JavaScript and web development in general
* working knowledge of UI/UX design principles

== Potential mentors ==

* Stefano Zacchiroli <zack@upsilon.cc> (zack on [[IRC]])

[[Category:Available GSoC task]]
[[Category:GSoC task]]