A discord bot framework!
Project description
Betterbot
A modern, event-driven bot framework for Python, designed for simplicity and flexibility.
Install
Install via pip:
pip install betterbot
How to Use
Import the Setup module and initialize your bot:
from betterbot import Setup
Example Bot Script
import asyncio
import json
from betterbot import Setup, Events, Intents
# Load bot token from configuration
with open("config.json") as f:
config = json.load(f)
TOKEN = config["TOKEN"]
class Bot:
def __init__(self):
self.bot = Setup(TOKEN, intents=Intents.all)
self.bot.debug = True # Enable detailed debug logs
self.rest = self.bot.rest_client
self.bot_username = None
self.event = self.bot.event
async def main(self):
# Register event handlers
await self.event.register(Events.BOT_READY, self.on_ready) # You can register multiple handlers per event.
await self.event.register(Events.MESSAGE_CREATE, self.on_message)
await self.bot.start()
# -----------------------
# Event Handlers
# -----------------------
async def on_ready(self, username, es):
self.bot_username = username
print(f"Logged in as {username}")
# Create a guild slash command
# Es stands for Event-Send use it in response to events/command events
await es.create_guild_command(
self.test_command,
guild_id=GUILD_ID,
name="testrest",
description="some example REST endpoints"
)
async def on_message(self, username, content, channel_id):
if username == self.bot_username:
return
print(f"{username}: {content}")
if content.lower() == "example rest":
await self.test_rest_methods()
# -----------------------
# Slash Command Handler
# -----------------------
async def test_command(self, es):
# Es is the prefered way to respond to events you can do it manually but that is not recommended
# Immediately respond to the interaction
await es.respond_message(content="Hello, it is starting!")
await self.test_rest_methods()
async def test_rest_methods(self):
# -----------------------
# Channel Methods
# -----------------------
await self.rest.send_message(CHANNEL_ID, "Hello from Betterbot REST test!")
messages = await self.rest.get_messages(CHANNEL_ID)
if messages:
msg_id = messages[0]["id"]
await self.rest.typing(CHANNEL_ID)
await self.rest.add_reaction(CHANNEL_ID, msg_id, "👍")
await self.rest.remove_reaction(CHANNEL_ID, msg_id, "👍")
await self.rest.pin_message(CHANNEL_ID, msg_id)
await self.rest.unpin_message(CHANNEL_ID, msg_id)
# -----------------------
# Guild Methods
# -----------------------
guild_info = await self.rest.get_guild_info(GUILD_ID)
members = await self.rest.get_guild_members(GUILD_ID, limit=5)
roles = await self.rest.get_guild_roles(GUILD_ID)
print("REST test complete!")
# -----------------------
# Run Bot
# -----------------------
asyncio.run(Bot().main())
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
betterbot-5.1.3.tar.gz
(36.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
betterbot-5.1.3-py3-none-any.whl
(57.3 kB
view details)
File details
Details for the file betterbot-5.1.3.tar.gz.
File metadata
- Download URL: betterbot-5.1.3.tar.gz
- Upload date:
- Size: 36.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b4068bcd03597fc69f053502c5b79520248c693989deb289f910ec8dc66104e
|
|
| MD5 |
7281884592b74cfc80048e9ebf25c3dc
|
|
| BLAKE2b-256 |
53fd9b082c1724f4c873f978b9e54e1804cae7305f0f655ef5f3db58875c66d7
|
File details
Details for the file betterbot-5.1.3-py3-none-any.whl.
File metadata
- Download URL: betterbot-5.1.3-py3-none-any.whl
- Upload date:
- Size: 57.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9aebd7ee31b70b4f6aaea48069e34fb75e27a4e1c4361832423fee424e5fb61a
|
|
| MD5 |
4f0fc21447293d0c3206c00587bce026
|
|
| BLAKE2b-256 |
0392ebb2233627ac879cbf6b0f0f9643475a4235640cde43dd708ec8f72226f6
|