Skip to content

Elias-YJ/fk-kiltisbot

 
 

Repository files navigation

Installation

Running kiltisbot requires python3 and virtualenv package. You can install virtualenv with

python3 -m pip install --user virtualenv

or you can install it globally without --user flag. Create virtual environment for bot with

python3 -m venv env

and activate environment and install dependencies with

source env/bin/activate
pip install -r requirements.txt

To start bot

python3 bot.py

Ctrl+C stops the bot. You might want to start bot in tmux session. To do so run

tmux new -s kiltisbot

Inside session start bot as above and detach from session by pressing Ctrl+b+d. You can later return to the session with

tmux a -t kiltisbot

Configuration

Bot is configured with python file. File config.py.example contains all variables that are needed to enjoy full functionality of kiltisbot. Copy file and name it config.py and fill missing parts.

Calendar events

First you have to create credentials.json file in Google API Console Credentials page. Select create credentials -> OAuth cliend ID -> select Desktop app for application type. Export json file, name it as credentials.json and place it in project root.

You need token.pickle file in your project root for calendar events to work correctly. When bot is started first time (when google_auth is imported first time) browser window opens where you can sign up with your Google account to get token.

Fiirumi

Press /subscribe in chat where you want to have notifications about new posts after you have added bot to chat.

Drive backend

Drive backend uses same token as calendar module. Drive backend enables importing and exporting database with telegram commands that are only available for admin users.

About

Source code of kiltisbot

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 59.8%
  • Jupyter Notebook 40.2%