Roid
🤖
A fast, stateless http slash commands framework for scale. Built by the Crunchy bot team.
🚀
Installation
You can install roid in it's default configuration via:
pip install roid
You can install with the optional speedups e.g. orjson with:
pip install roid[speedups]
📚
Getting Started
You can get started with the following options, most of the public API is type hinted and a lot of the framework depends around this so you should be able to stand on your own two feet reasonable quickly.
- Examples are the best / only place to start.
✨
Basic Example
import os
import uvicorn
import roid
application_id = os.getenv("APPLICATION_ID")
public_key = os.getenv("PUBLIC_KEY")
token = os.getenv("BOT_TOKEN")
app = roid.SlashCommands(application_id, public_key, token)
# We can create async commands
@app.command("echo", "Echo a message.", guild_id=675647130647658527)
async def echo(message: str):
return Response(content=message, flags=ResponseFlags.EPHEMERAL)
# Or sync commands which are ran in another thread.
# While this is not advised for everything, we do provide threadsafe interfaces
# to the state management system.
@app.command("echo-sync", "Echo a message with threading.", guild_id=675647130647658527)
def echo_sync(message: str):
return Response(content=message, flags=ResponseFlags.EPHEMERAL)
if __name__ == "__main__":
app.register_commands_on_start()
uvicorn.run("app:app", port=8000)
❤️
Developer Note
Please note that this library is largely designed around what we need the framework to do rather than strictly as a general API framework.
You may notice rather opinionated things e.g. how we work command groups. Which are a trait of that. These things are generally subject to change with Discord but right now we thing the standard command groups look rather poor.
This framework is not for everyone, if you need the gateway or general REST api calls this is probably not the framework for you. (Although if you would like to add some more of the slash commands REST api then feel free to PR.)
This is also why there generally arent any forms of online docs for this, i'll get around to it, eventually.
173 Dec 19, 2022
17 Oct 21, 2022
2 Jan 6, 2022
4.8k Dec 30, 2022
![[Ͼ⁴] Ƶephyr](https://avatars.githubusercontent.com/u/76829032?v=4&s=60)
2 Dec 2, 2021
2 Jan 11, 2022
8.6k Dec 29, 2022
3 Feb 19, 2022
4 Dec 4, 2021
1 May 22, 2022
59 Dec 4, 2022
1 Oct 13, 2021
2.2k Jan 8, 2023
4k Jan 8, 2023
13 Dec 15, 2022
641 Jan 3, 2023
3 Jun 1, 2022
28 Nov 16, 2022
17k Jan 2, 2023
1.1k Dec 31, 2022
4 Feb 5, 2022
11 Mar 24, 2021
7 Oct 17, 2022
3 Aug 11, 2022
6 Jan 8, 2022
18 Nov 15, 2022
8 Dec 20, 2022