reonokiy/swh-lister
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README.md: Add a section to demo how to run the gitlab lister

Browse source 
Related T989
This commit is contained in:
Antoine R. Dumont (@ardumont) 2018-07-04 15:14:06 +02:00
parent 3ca566776f
commit a527977b6c
No known key found for this signature in database
GPG key ID: 52E2E9840D10C3B8
1 changed files with 45 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -43,7 +43,7 @@ Local deployment
### Preparation steps
1. git clone under $GHLISTER_ROOT (of your choosing)
1. git clone under $SWH_ENVIRONMENT_HOME/swh-lister (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
@ -61,7 +61,6 @@ Local deployment
credentials: []
cache_responses: True
cache_dir: /home/zack/.cache/swh/lister/github.com
storage:
cls: remote
args:
@ -79,3 +78,47 @@ Local deployment
DEBUG:urllib3.connectionpool:https://api.github.com:443 "GET /repositories?since=364 HTTP/1.1" 200 None
DEBUG:urllib3.connectionpool:Starting new HTTP connection (1): localhost
DEBUG:urllib3.connectionpool:http://localhost:5002 "POST /origin/add HTTP/1.1" 200 1
## lister-gitlab
### preparation steps
1. git clone under $SWH_ENVIRONMENT_HOME/swh-lister (of your choosing)
2. mkdir ~/.config/swh/ ~/.cache/swh/lister/gitlab/
3. create configuration file ~/.config/swh/lister-gitlab.yml
4. Bootstrap the db instance schema
$ createdb lister-gitlab
$ python3 -m swh.lister.cli --db-url postgres:///lister-gitlab \
--lister gitlab \
--create-tables
### Configuration file sample
$ cat ~/.config/swh/lister-gitlab.yml
# see http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
lister_db_url: postgres:///lister-gitlab
credentials: []
cache_responses: True
cache_dir: /home/zack/.cache/swh/lister/gitlab
storage:
cls: remote
args:
url: http://localhost:5002/
### Run
$ python3
Python 3.6.6 (default, Jun 27 2018, 14:44:17)
[GCC 8.1.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from swh.lister.gitlab.tasks import RangeGitLabLister; RangeGitLabLister().run_task(1, 2,
instance='salsa.debian.org', api_baseurl='https://salsa.debian.org/api/v4')
>>> from swh.lister.gitlab.tasks import RangeGitLabLister; RangeGitLabLister().run_task(1, 2,
instance='gitlab.freedesktop.org', api_baseurl='https://gitlab.freedesktop.org/api/v4')
>>> from swh.lister.gitlab.tasks import RangeGitLabLister; RangeGitLabLister().run_task(1, 2,
instance='gitlab.gnome.org', api_baseurl='https://gitlab.gnome.org/api/v4')
>>> from swh.lister.gitlab.tasks import RangeGitLabLister; RangeGitLabLister().run_task(1, 2,
instance='gitlab.inria.fr', api_baseurl='https://gitlab.inria.fr/api/v4')
>>>