scurrypy 0.6.7

Dataclass-driven Discord API Wrapper in Python

ScurryPy

A dataclass-driven Discord API wrapper in Python!

While this wrapper is mainly used for various squirrel-related shenanigans, it can also be used for more generic bot purposes.

Features

• Easy to extend
• Command, and event handling
• Unix shell-style wildcards for component routing
• Declarative style using decorators
• Supports both legacy and new features
• Respects Discord's rate limits
• No __future__ hacks to avoid circular import
• Capable of sharding

Benchmarks

Not convinced ScurryPy has a place among top libraries? See the benchmarks below!

Test Environment

• Python: 3.11.6
• OS: Windows 11

Results Summary

Library         Time (ms)    Memory Δ (MB)      Objects
--------------------------------------------------------
hikari              ~2700            27.67        53658
discord              ~300             7.64        14099
disnake              ~200             6.31        12111
scurrypy              ~18             0.44         1417

(See tests/benchmark.py for how this test was done.)

Getting Started

Note: This section also appears in the documentation, but here are complete examples ready to use with your bot credentials.

Installation

To install the ScurryPy package, run:

pip install scurrypy

Minimal Slash Command

The following demonstrates building and responding to a slash command.

import scurrypy

client = scurrypy.Client(
    token='your-token',
    application_id=APPLICATION_ID  # your bot's application ID
)

@client.command(
    scurrypy.SlashCommand('example', 'Demonstrate the minimal slash command!'), 
    GUILD_ID  # must be a guild ID your bot is in
)
async def example(bot: scurrypy.Client, event: scurrypy.InteractionEvent):
    await event.interaction.respond(f'Hello, {event.interaction.member.user.username}!')

client.run()

Minimal Prefix Command (Legacy)

The following demonstrates building and responding to a message prefix command.

import scurrypy

client = scurrypy.Client(
    token='your-token',
    application_id=APPLICATION_ID,  # your bot's application ID
    intents=scurrypy.set_intents(message_content=True),
    prefix='!'  # your custom prefix
)

@client.prefix_command("ping")
async def on_ping(bot: scurrypy.Client, event: scurrypy.MessageCreateEvent):
    await event.message.send("Pong!")

client.run()

Like What You See?

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