MoralCode / pawprints-notify

A discord bot to automatically post information about new pawprints in a discord server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pawprints notification discord bot

This is a discord bot that aims to provide notifications when new pawprints are posted, so that more members of the RIT community can participate and vote on issues that are raised

Usage

Grant the bot access to your server: TODO: add oauth link here

To subscribe to a feed of pawprints, an administrator must run the command /subscribe in the channel that should be subscribed to

Development

To run the bot locally, you need to make a .env file containing the text DISCORD_TOKEN= followed by a discord bot token created from the discord developer portal.

This bot also depends on the pawprints-api library/repo, which it currently expects to be cloned into a directory at the same level as it.

Docker

Then you can build the docker container with docker build -t <image name> .. The database will generate on first run.

To run the bot, you can use the command docker run --rm --env-file .env <image name>.

Python

This codebase is primarily managed with pipenv. To install dependencies, install pipenv and then run pipenv install.

To run the project, run pipenv run python3 ./pawprints-bot.py

This assumes you have a valid database set up. if you dont have this, run pipenv run python3 ./database.py

About

A discord bot to automatically post information about new pawprints in a discord server

License:GNU General Public License v3.0


Languages

Language:Python 93.9%Language:Mako 4.2%Language:Dockerfile 1.9%