Setup for Development

Requirements

• Python 3.10.2 or above: Windows, MacOS, Linux
• Git

Clone this repo

$ git clone https://github.com/mdgspace/github-slack-bot.git
$ cd github-slack-bot

Create a virtual environment

$ python -m venv venv

Or, if your system contains both Python 2 and Python 3, use python3.

Activate your virtual environment

MacOS and Linux:

$ source venv/bin/activate

Windows:

> venv\Scripts\activate

Install dependencies

$ pip install -r requirements.txt

Or, if your system contains both Python 2 and Python 3, use pip3.

Enable git hooks

$ pip install pre-commit
$ pre-commit install

Get the environment variables from a maintainer

Download and configure ngrok

Run the bot

$ python main.py