reonokiy/swh-lister
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
160 commits 1 branch 0 tags 16 MiB
Find a file
Antoine R. Dumont (@ardumont) 8ad70b3d60
swh.lister.gitlab: Make the lister instance parametric 
This impacts:
- the credentials reading which needs to be indexed per instance
- the models since a new instance column needs to referenced and
  indexed

Related T989
2018-07-11 11:16:42 +02:00
bin README: Fix and document how to boostrap github lister model 2018-06-27 09:52:55 +02:00
debian Clean up dependencies to enable tests on build 2017-10-30 17:04:49 +01:00
docs docs/tutorials: Format sentences 2018-06-26 10:48:12 +02:00
sql Revert to the pre-qless refactoring version 2016-09-13 14:57:26 +02:00
swh swh.lister.gitlab: Make the lister instance parametric 2018-07-11 11:16:42 +02: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.md swh.lister.cli: Simplify cli 2018-07-11 09:45:51 +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

README.md

SWH-lister

The Software Heritage Lister is both a library module to permit to centralize lister behaviors, and to provide lister implementations.

Actual lister implementations are:

  • swh-lister-debian
  • swh-lister-github
  • swh-lister-bitbucket

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-requests
  • python3-sqlalchemy

More details in requirements*.txt

Local deployment

lister-github

  1. git clone under $GHLISTER_ROOT (of your choosing)

  2. mkdir ~/.config/swh/ ~/.cache/swh/lister/github.com/

  3. create configuration file ~/.config/swh/lister-github.com.yml

  4. Bootstrap the db instance schema

    $ createdb lister-github $ python3 -m swh.lister.cli --db-url postgres:///lister-github
    --lister github
    --create-tables

Configuration file samples

github

cat ~/.config/swh/lister-github.com.yml

# see http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
lister_db_url: postgres:///lister-github.com
credentials: []
cache_responses: True
cache_dir: /home/zack/.cache/swh/lister/github.com

storage:
  cls: remote
  args:
    url: http://localhost:5002/