https://github.com/moralcode/pawprints-notify
A discord bot to automatically post information about new pawprints in a discord server
https://github.com/moralcode/pawprints-notify
rochester-institute-of-technology
Last synced: 10 months ago
JSON representation
A discord bot to automatically post information about new pawprints in a discord server
- Host: GitHub
- URL: https://github.com/moralcode/pawprints-notify
- Owner: MoralCode
- License: gpl-3.0
- Created: 2023-03-05T16:41:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-27T13:56:34.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T08:21:53.401Z (12 months ago)
- Topics: rochester-institute-of-technology
- Language: Python
- Homepage:
- Size: 119 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/MoralCode/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 .`. The database will generate on first run.
To run the bot, you can use the command `docker run --rm --env-file .env `.
### 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`