swh-lister/README

37 lines
No EOL
1.1 KiB
Text

Licensing
=========
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
See top-level LICENSE file for the full text of the GNU General Public License
along with this program.
Dependencies
============
See requirements.txt
Deployment
==========
The github lister can be run standalone by using `python3 -m swh.lister.github.lister`.
Sample configuration file
-------------------------
cat ~/.config/swh/lister/github.ini
[main]
storage_class = local_storage
storage_args = dbname=softwareheritage-dev, /srv/softwareheritage/objects
queue_file = ~/.cache/swh/lister-github/queue.pickle
credentials = olasd:olasd_github_token, zacchiro:zacchiro_github_token