README.rst



Software Heritage - Listers
Collection of listers for source code distribution places like development
forges, FOSS distributions, package managers, etc. Each lister is in charge to
enumerate the software origins (e.g., VCS, packages, etc.) available at a
source code distribution place.
A lister is a component from the Software Heritage stack aims to produce
listings of software origins and their urls hosted on various public developer
platforms or package managers. As these operations are quite similar, this
package provides a set of Python modules abstracting common software origins
listing behaviors.
It also provides several lister implementations, contained in the Python
swh.lister.* modules. See this documentation for the list of
supported listers.

Dependencies
All required python dependencies can be found in the requirements*.txt files
located at the root of the repository.
In order to be able to run all the listers (and thus execute the tests), some
tools must be available on your system, namely:

opam
tar
psql

On a Debian-like system, you may use:

Local deployment

Lister configuration
Each lister implemented so far by Software Heritage (bitbucket, cgit,
cran, debian, gitea, github, gitlab, gnu, golang,
launchpad, npm, packagist, phabricator, pypi, tuleap,
maven) must be configured by following the instructions below (please note
that you have to replace <lister_name> by one of the lister name introduced
above).

Preparation steps

mkdir ~/.config/swh/
create configuration file ~/.config/swh/listers.yml


Configuration file sample