Configurable bot used for automatic Github issues labeling
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
github_labelbot
.gitignore
LICENSE
MANIFEST.in
Procfile
README.rst
requirements.txt
runtime.txt
setup.py

README.rst

Documentation Status

Github Labelbot

Configurable Github bot used for automatic issues labeling

Sample webhook is running at https://labelbot-api.herokuapp.com/ and it's functionality can be tested in https://github.com/Fanarim/github_labelbot_testrepo repository.

Documentation is available at Read The Docs.

Configuration

TBA

Installation and running

Clone the repo and install necessary packages:

$ git clone https://github.com/Fanarim/github_labelbot
$ virtualenv -p python3 venv
$ source venv/bin/activate
$ ./setup.py install

Alternativelly you can install Labelbot using pip:

$ python -m pip install --extra-index-url https://testpypi.python.org/pypi github-labelbot

Now you can run the command:

$ labelbot --help

Heroku deployment

While deploying the app on Heroku, following environment variables have to be set:

WEBHOOK_TOKEN=webhook_token - GitHub webhook secret/token
GITHUB_TOKEN=github_token - GitHub API token

Documentation generation

To regenerate the documentation, run the following commands:

$ cd docs
$ make html

About

Github Labelbot is being developed as part of MI-PYT course at Faculty of Information technology, Czech Technical University in Prague.