Page Menu
Home
Software Heritage
Search
Configure Global Search
Log In
Files
F9697748
D372.id1172.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
2 KB
Subscribers
None
D372.id1172.diff
View Options
diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -43,7 +43,7 @@
### 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 @@
credentials: []
cache_responses: True
cache_dir: /home/zack/.cache/swh/lister/github.com
-
storage:
cls: remote
args:
@@ -79,3 +78,47 @@
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')
+ >>>
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Mon, Aug 18, 12:47 AM (3 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3218743
Attached To
D372: README.md: Add a section to demo how to run the gitlab lister
Event Timeline
Log In to Comment