Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephanakkerman/github-issue-bot
A simple script for creating GitHub issues through Discord commands
https://github.com/stephanakkerman/github-issue-bot
discord discord-bot discord-py github github-api issue issues pygithub python
Last synced: 6 days ago
JSON representation
A simple script for creating GitHub issues through Discord commands
- Host: GitHub
- URL: https://github.com/stephanakkerman/github-issue-bot
- Owner: StephanAkkerman
- License: mit
- Created: 2022-01-10T21:36:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-25T16:01:26.000Z (8 months ago)
- Last Synced: 2025-01-21T20:59:25.924Z (9 days ago)
- Topics: discord, discord-bot, discord-py, github, github-api, issue, issues, pygithub, python
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Issue Discord Bot
This is a simple Python script for a Discord bot that can create GitHub issues through Discord commands.\
[](https://www.python.org/downloads/release/python-380/)
[](https://github.com/psf/black)
[](https://opensource.org/licenses/MIT)
---
## Setup
The first step is creating a Discord bot, setting up the basics, and inviting it to your server. For the first part you can watch this [video (watch until 2:20)](https://www.youtube.com/watch?v=Pbq7vPsHDtc).
Or follow these written instructions:
- Setup your own Discord bot, following this [written tutorial](https://realpython.com/how-to-make-a-discord-bot-python/) or this
- Give the bot admin rights and all permissions possible, since this is the easiest way to set it up.
- Invite the bot to your server.
- Create the text channel where you would like to receive your Instagram updates in.
Last you need to fill in the important information in `config_example.yaml`, so the bot knows which server it should be connected to.
- Open `config.yaml`
- Write your bot token behind `TOKEN:` (line 2)
- Write your server name behind `GUILD_NAME:` (line 3)
- Change the value behind `REPO:` (line 11)
## GitHub Token
To create a personal access token go to this [website](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and follow the tutorial.
IMPORTANT: This bot needs no GitHub permissions so you can keep everything turned off in what you see at step 8.
After generating the token copy and paste it behind `TOKEN:` (line 10) in `config.yaml`.
## GitHub Labels
This bot supports adding labels to new issues. However, your labels need to end with an emoji, below is an overview of the default labels we use:
- Bug 🐛
- Important ❗
- Improvement 📈
- Low priority 🥉
- Medium priority 🥈
- Top priority 🥇
- New feature ⭐
- Overhaul 🌈
- Text change ✍️
## Combining with your own bot
If you would like to combine this bot with your own bot, copy the `main.py` file and load your own Discord extenions.
See line 31 in `main.py` on how to do this, or check out my other Discord bot for more extensive Discord bots and examples.
## Dependencies
The required packages to run this code can be found in the `requirements.txt` file. To run this file, execute the following code block:
```
$ pip install -r requirements.txt
```
Alternatively, you can install the required packages manually like this:
```
$ pip install
```
## How to run
- Clone the repository
- Fill in the fields in config.yaml
- Run `$ python src/main.py`
- Type `!issue` in your server
- See result