diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -41,25 +41,23 @@ ## lister-github +### Preparation steps + 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 ``` sh -$ createdb lister-github.com -$ python3 -m swh.lister.cli --db-url postgres:///lister-github.com github --createdb +$ createdb lister-github +$ python3 -m swh.lister.cli --db-url postgres:///lister-github github --createdb ``` -Configuration file samples -------------------------- - -## github - -cat ~/.config/swh/lister-github.com.yml +### Configuration file sample + $ 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 + lister_db_url: postgres:///lister-github credentials: [] cache_responses: True cache_dir: /home/zack/.cache/swh/lister/github.com @@ -68,3 +66,16 @@ cls: remote args: url: http://localhost:5002/ + +### Run + + $ python3 + >>> import logging + >>> logging.basicConfig(level=logging.DEBUG) + >>> from swh.lister.github.tasks import RangeGitHubLister + >>> RangeGitHubLister().run(364, 365) + INFO:root:listing repos starting at 364 + DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): api.github.com + 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