swh-lister

No description

Find a file

Stefano Zacchiroli b8ad57fc05 docs: integrate swh-lister tutorial originally appeared on the Software Heritage blog at https://www.softwareheritage.org/2017/03/24/list-the-content-of-your-favorite-forge-in-just-a-few-steps/ by Avi Kelman Closes T762		2017-11-02 17:53:30 +01:00
bin	lister.py: class-ify the GitHub lister	2016-10-20 14:22:31 +02:00
debian	Clean up dependencies to enable tests on build	2017-10-30 17:04:49 +01:00
docs	docs: integrate swh-lister tutorial	2017-11-02 17:53:30 +01:00
etc	Revert to the pre-qless refactoring version	2016-09-13 14:57:26 +02:00
sql	Revert to the pre-qless refactoring version	2016-09-13 14:57:26 +02:00
swh	Force utf-8 encoding for tests	2017-10-30 17:05:18 +01:00
.gitignore	lister_transports: load version by using vcversioner's export module	2017-10-10 16:36:38 +02:00
ACKNOWLEDGEMENTS	add ACKNOWLEDGEMENTS	2015-04-26 15:54:25 +02:00
LICENSE	add license information	2015-04-26 16:24:32 +02:00
Makefile	Makefile: add from swh-py-template	2015-10-27 14:35:54 +01:00
MANIFEST.in	Clean up dependencies to enable tests on build	2017-10-30 17:04:49 +01:00
README	Revert to the pre-qless refactoring version	2016-09-13 14:57:26 +02:00
requirements-swh.txt	swh.storage is the requirement with the schemata stuff	2017-10-30 17:06:02 +01:00
requirements-test.txt	Clean up dependencies to enable tests on build	2017-10-30 17:04:49 +01:00
requirements.txt	Clean up dependencies to enable tests on build	2017-10-30 17:04:49 +01:00
setup.py	Make setup.py use nose for tests	2017-10-30 17:11:25 +01:00
TODO	Revert to the pre-qless refactoring version	2016-09-13 14:57:26 +02:00

README

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
============

- python3
- python3-psycopg2
- python3-requests
- python3-sqlalchemy


Deployment
==========

1. git clone under $GHLISTER_ROOT (of your choosing)
2. mkdir ~/.config/swh/ ~/.cache/swh/lister-github/
3. edit $GHLISTER_ROOT/etc/crontab and customize GHLISTER_ROOT
4. crontab $GHLISTER_ROOT/etc/crontab
5. create configuration file ~/.config/swh/lister-github.ini

Sample configuration file
-------------------------

cat ~/.config/swh/lister-github.ini

        [main]
        db_url = postgres:///github
          # see http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
        cache_dir = /home/zack/.cache/swh/lister-github
        log_dir =   /home/zack/.cache/swh/lister-github
        username = foobar  # github username
        password = quux    # github password