supershadoe / ritsu

A discord bot to fetch information from various API

Ritsu

An always-online Discord bot to fetch information from various API

Info

• 📄 Licensed under Apache-2.0
• ⚙️ Requires TypeScript 4.9 or 4.9+ (particularly due to use of satisfies operator)
• ⚙️ Uses ES modules and not CJS
• 🚀 Minimal amount of dependencies
• 🔶 Powered by Cloudflare Workers
• 🔗 Bot Invite Link

Features

• Searching and fetching articles from Wikipedia.
• Searching and fetching articles from various fandom pages.
• Searching and fetching the details of a compound from PubChem using their PUG API.

How to run this bot

1. Install node.js and npm.
2. Clone this repository: git clone https://github.com/supershadoe/ritsu.
3. Create a worker in Cloudflare's dashboard.
4. Run npm update to download all node modules.
5. Set your worker's name and domain/routes in wrangler.toml.
6. Login to your Cloudflare account using wrangler: npx wrangler login.
7. Run a locally hosted bot for development purposes using npx wrangler dev additionally with --local if you want to just use miniflare and not connect to a Cloudflare server for using KV and durable objects (this bot doesn't need those right now).
8. Upload the code to run serverlessly on any cloudflare datacenter using npx wrangler publish.

ritsu's Issues

Switch to dataclasses to represent database tables

Using methods is fine and all but it just gets tiring and lot of bloat. Also, using dataclass/attrs class to represent records of table will help with better typing.

Implement ratelimits for PubChem command

According to their usage policy,

USAGE POLICY: Please note that PUG REST is not designed for very large volumes (millions) of requests.
We ask that any script or application not make more than 5 requests per second, in order to avoid overloading the PubChem servers.

Side note from me:
Due to the above usage policy, it's not easily possible to add an autocomplete feature for compounds in slash command.
I would either need to download the entire DB and write code to cache it efficiently and fetch data... There's no way around it.
Spotty autocomplete which works sporadically due to ratelimits is kinda useless, innit?

Add cache in PubChem command

• Although it's one of the rarely used (and only one of the 2 commands on this small bot), it's probably better to have some sort of cache of responses from PubChem