Summarize GitHub issues
Install requirements:
pip install -r requirements.txt
To run the development server:
FLASK_ENV=development FLASK_APP=thumbsup.server flask run
To run production server:
gunicorn --bind 0.0.0.0:5000 thumbsup.server:app
To build the image:
docker build -t simiotics/thumbsup .
To run a container:
docker run -p 5000:5000 simiotics/thumbsup
Once you have a server set up, Thumbsup should be available at localhost:5000
Thumbsup uses the GitHub API to retrieve issue comments. If you do not provide a GitHub access token, Thumbsup is subject to the unauthenticated GitHub API rate limit of 60 calls per hour.
You can provide a GitHub access token
by setting it as the value for the THUMBSUP_GITHUB_TOKEN
environment variable. This will bring
your available rate limit to 5000 requests per hour (higher if you have a better GitHub plan).
You can also set a minimum rate limit threshold below which Thumbsup will fail all requests. To do
this, set the THUMBSUP_RATE_LIMIT_BOUND
to an integer value.
To pass these environment variables to Thumbsup through docker, assuming they are set in your shell:
docker run -p 5000:5000 \
-e THUMBSUP_GITHUB_TOKEN="$THUMBSUP_GITHUB_TOKEN" \
-e THUMBSUP_RATE_LIMIT_BOUND="$THUMBSUP_RATE_LIMIT_BOUND" \
simiotics/thumbsup
See sample.env for an example of how to set these environment variables. To use it locally:
-
Run
$ cp sample.env my.env
-
Update the values in
my.env
. -
Source the file:
$ . my.env
.