rrsharpe / specsbot

SpecsBot

This project is the source code for /u/SpecsBot that currently runs in /r/bapcsalescanada. It was inspired by a similar project but plans to add more features.

---

Running the bot

You must have go version 1.19 or greater installed to build and run. You can find the latest installer for your system here.

To build the application, run the following command to create a binary for your system.

go build ./...

Alternatively you can use the Dockerfile to build this on any system.

docker build .

To run the application you need to set the following environment variables

• BOT_AGENT - A user agent for your bot as defined here
• BOT_ID - The Reddit OAuth2 client_id
• BOT_SECRET - The Reddit OAuth2 secret
• BOT_USERNAME - The username of your bot
• BOT_PASSWORD - The password of the bot account
• SUBREDDIT - The subreddit you want to scan (eg bapcsalescanada)

---

Project Structure

This project is separated into packages. The main package simply fetches and calls the various post handlers from each child module. Whenever a post from the followed subreddit is detected, each module's post handler will be called. It is up to each post handler to only respond to their type of post.

---

License

This project's code is licensed under the MIT license. However, some of the resources used by this bot such as spreadsheets are not. Therefore, while the source code of this project is licensed under MIT, the comments created by this bot and the resources it dynamically fetches at run time may not be MIT licensed.

specsbot's Issues

Add a user mentions handler

We should have a way to summon the bot in the comments

Switch imported GRAW to maxime915's fork

https://github.com/maxime915/graw

It doesn't seem like their PR will be merged into the main GRAW repository. Giving access to Reaper will allow other API endpoints to be used. This should enable editing or deleting comments.

Update the footer message to link to this GitHub repo

Currently, no one knows this bot is open source (well as of writing it isn't yet). Please let people know they can raise issues or feature requests here. Make sure to keep the footer concise.

Support PSU tierlist

https://cultists.network/140/psu-tier-list/

• This is licensed under CC BY NC SA license so attribution under the license is needed.
• An xlsx parser is needed due to the merged cells

Add a comment reply handler for deletion

We should have a way for people to delete posts. Since the bot pulls previous posts, we can't delete or else the post may come back. Instead, edit the post replacing it with who removed it.