Skip to main content

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.1.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

betterbot-5.1.1-py3-none-any.whl (57.3 kB view details)

Uploaded Python 3

File details

Details for the file betterbot-5.1.1.tar.gz.

File metadata

  • Download URL: betterbot-5.1.1.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

Hashes for betterbot-5.1.1.tar.gz
Algorithm Hash digest
SHA256 f4b2114280d9ca650107e76dbf4cf4918a37abe6f7901cfbed4506515ba29cc0
MD5 1dca057795b4a232da2957430f5ff0ee
BLAKE2b-256 9a635dce6529b27b0db060e7d2a0eddced4d2b07d348ec404261357eb08cb878

See more details on using hashes here.

File details

Details for the file betterbot-5.1.1-py3-none-any.whl.

File metadata

  • Download URL: betterbot-5.1.1-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

Hashes for betterbot-5.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9455cc35485fd84023ef3ef1b33b752d2c4238e23f8f55b30d6afa4f2b8956c6
MD5 b1c25204fe032021faab466e1be7777c
BLAKE2b-256 e74d0b89d8c95b053825d17cb32399ab4402617528bae606c8357f53d80e9917

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page