Difference between revisions of "Mine information from archived content (GSoC task)"

From Software Heritage Wiki
Jump to: navigation, search
(Potential mentors)
Line 50: Line 50:
* Valentin Lorentz (vlorentz on [[IRC]])
* Valentin Lorentz (vlorentz on [[IRC]])
[[Category:Available GSoC task]]
[[Category:GSoC task]]
[[Category:GSoC task]]

Revision as of 11:59, 8 February 2022


In addition to archival, Software Heritage indexes the retrieved source code artifacts, to enable semantic searches on the archive and scientific research.

Indexing can happen at the individual file-level (e.g., detect the programming language the file is written in or the license declared in its header), or at more coarse grained granularity (e.g., what metadata are declared for the most recently archived version of a given project).

A number of indexes are currently supported, such as:

  • file level mining:
    • MIME type detection (using libmagic)
    • license detection (using FOSSology/nomossa)
    • language detection (using Pygments)
    • ctags extraction (using universal-ctags)
  • project level mining:
    • Ruby gemspec metadata
    • Python PKG-INFO metadata
    • Maven pom.xml metadata
    • NPM package.json metadata

Task description

Writing additional indexers that extract more information from archived source code is welcome and would constitute a suitable GSoC project.

Name the kind of data mining you want to do!

For inspiration you can have a look at Libraries.io, as most package formats/package managers support dedicated ways of expressing metadata and we only support a small number of them up-to-now. But do not restrict your ambition to those, any kind of data extraction/mining you want to do on the archive could work.

You may also add support for multiple formats at once, using an external tool, such as Bolognese or bibliothecary.

Desirable skills

  • Python 3 and Git are a must to work on any Software Heritage project
  • Prior experience in working with (source code) metadata is a plus, but not required

Potential mentors

  • Stefano Zacchiroli <zack@upsilon.cc> (zack on IRC)
  • Valentin Lorentz (vlorentz on IRC)