Skip to content

IRC bot based on `irc3` that allows searching issues/PRs in the Kakoune repository

License

Notifications You must be signed in to change notification settings

lenormf/kakoune-zidane

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kakoune-zidane

This project implements a small Github plugin for irc3, and a configuration file that sets up an IRC bot to run on Kakoune's channel.

Instructions

Setup

Python 3 is required to run the bot.

$ git clone https://github.com/lenormf/kakoune-zidane.git
$ cd kakoune-zidane

The recommended way to run the bot is by setting up a virtual environment, but this step is optional:

$ python3 -m venv .env
$ source .env/bin/activate

Install the dependencies in the requirements.txt file, either manually or using the pip package manager:

$ pip3 install -r requirements.txt

Configuration

Create a dedicated access token on your Github profile, and grant it the following permissions:

  • public_repo

Once successfully created, declare this token (which should be kept secret) in the bot’s configuration file:

# zidane.cfg

[github_plugin]

token = <token>

Tweak other irc3 settings if necessary.

Running

Use the following command to start the bot:

$ irc3 zidane.cfg

Refer to the documentation of irc3 to learn more about additional flags (e.g. -d for debugging).

About

IRC bot based on `irc3` that allows searching issues/PRs in the Kakoune repository

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages