scurrypy 2.0.0

Dataclass-driven Discord API Wrapper in Python

ScurryPy

✨ Clarity over magic: build a bot that lasts ✨

Features

• Lightweight core
• Rate limit handling
• Automatic session & gateway management
• Automatic sharding
• Predictable event models and resource classes

Your focus is building what you want instead of fighting a framework.

Installation

Install ScurryPy with pip:

pip install scurrypy

Examples

The following examples are quick drop-in starters if you wish to try ScurryPy.

[!TIP] It is recommended to use a .env file for bot tokens. More details about using a .env file here.

Slash Command

# Set TOKEN, APP_ID (bot user ID), and GUILD_ID (for guild command)

# --- Core library imports ---
from scurrypy import Client, EventTypes, InteractionEvent, SlashCommandPart

# --- Setup bot ---
client = Client(token=TOKEN)

async def on_greet(event: InteractionEvent):
    """Respond to /greet"""
    if event.data.name != "greet":
        return

    await client.interaction(event.id, event.token).respond("Hello!")

async def register_commands():
    """Register slash commands on startup (before READY)."""
    await client.guild_command(APP_ID, GUILD_ID).create(
        SlashCommandPart("greet", "Greet the bot!")
    )

client.add_startup_hook(register_commands)
client.add_event_listener(EventTypes.INTERACTION_CREATE, on_greet)

# --- Run the bot ---
client.run()

Prefix Command (Legacy)

# Set TOKEN

# --- Core library imports ---
from scurrypy import Client, Intents, EventTypes, MessageCreateEvent

client = Client(token=TOKEN, intents=Intents.DEFAULT | Intents.MESSAGE_CONTENT)

# --- Setup bot ---
async def on_ping(event: MessageCreateEvent):
    if not event.content:
        return
    
    if not event.content.startswith('!ping'):
        return
    
    await client.channel(event.channel_id).send("Pong!")

client.add_event_listener(EventTypes.MESSAGE_CREATE, on_ping)

# --- Run the bot ---
client.run()

Dependencies

ScurryPy has exactly 3 required dependencies:

• aiohttp (HTTP client)
• websockets (Gateway connection)
• aiofiles (Async file operations)

These dependencies are automatically installed with ScurryPy's pip package.

Learn More

Explore the full documentation for more examples, guides, and API reference.

See the manifesto section for details!

Switching from discord.py? Check out the Migration Guide to see the difference.

Got some questions? Check out the FAQ page for commonly asked questions!

Looking for changes? See the Changelog.