scurrypy 0.3.2__tar.gz → 0.6.5__tar.gz

scurrypy-0.6.5/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2025 Furmissile. All rights reserved.
+
+Permission is granted to view, use, modify, and distribute copies of this software
+and its source code, provided that:
+
+1. Attribution to the original author, Furmissile, is preserved in all copies and
+   derivative works.
+2. The name "ScurryPy" and associated branding may not be used to promote derived
+   projects without explicit permission.
+3. This license and copyright notice must be included in all copies or substantial
+   portions of the software.
+4. This software is provided "as is", without warranty of any kind, express or
+   implied. The author assumes no liability for any damages arising from its use.
+
+5. This software may not be used for commercial purposes without written consent 
+   from the author.

scurrypy-0.6.5/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: scurrypy
+Version: 0.6.5
+Summary: Dataclass-driven Discord API Wrapper in Python
+Author: Furmissile
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: websockets>=11.0.0
+Dynamic: license-file
+
+# __ScurryPy__
+
+[![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/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
+- **Method**: New Python process per measurement
+- **Tool**: See benchmarks folder
+
+### Results Summary
+
+```
+Library         Time (ms)    Memory Δ (MB)      Objects
+--------------------------------------------------------
+scurrypy              8.9             0.44         1417
+hikari             1710.3            27.67        53658
+discord             252.5             7.64        14099
+disnake             185.9             6.31        12111
+```
+
+*(See `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:
+
+```bash
+pip install scurrypy
+```
+
+## Minimal Slash Command
+
+The following demonstrates building and responding to a slash command.
+
+```py
+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.
+
+```py
+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](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference.

scurrypy-0.6.5/README.md

@@ -0,0 +1,98 @@
+# __ScurryPy__
+
+[![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/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
+- **Method**: New Python process per measurement
+- **Tool**: See benchmarks folder
+
+### Results Summary
+
+```
+Library         Time (ms)    Memory Δ (MB)      Objects
+--------------------------------------------------------
+scurrypy              8.9             0.44         1417
+hikari             1710.3            27.67        53658
+discord             252.5             7.64        14099
+disnake             185.9             6.31        12111
+```
+
+*(See `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:
+
+```bash
+pip install scurrypy
+```
+
+## Minimal Slash Command
+
+The following demonstrates building and responding to a slash command.
+
+```py
+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.
+
+```py
+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](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference.

scurrypy-0.6.5/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scurrypy"
+version = "0.6.5"
+
+description = "Dataclass-driven Discord API Wrapper in Python"
+readme = "README.md"
+authors = [{ name = "Furmissile" }]
+requires-python = ">=3.10"
+dependencies = [
+  "aiohttp>=3.8.0",
+  "websockets>=11.0.0"
+]
+
+[tool.setuptools]
+packages = [
+  "scurrypy",
+  "scurrypy.dispatch",
+  "scurrypy.events",
+  "scurrypy.resources",
+  "scurrypy.parts"
+]

scurrypy-0.6.5/scurrypy/__init__.py

@@ -0,0 +1,429 @@
+# scurrypy
+
+import importlib
+from typing import TYPE_CHECKING
+
+__all__ = [
+    # top-level modules
+    "Logger", "Client", "Intents", "set_intents", "BaseConfig",
+
+    # events
+    "InteractionTypes", "ReadyEvent",
+    "ReactionAddEvent", "ReactionRemoveEvent", "ReactionRemoveEmojiEvent", "ReactionRemoveAllEvent",
+    "GuildCreateEvent", "GuildUpdateEvent", "GuildDeleteEvent",
+    "MessageCreateEvent", "MessageUpdateEvent", "MessageDeleteEvent",
+    "GuildChannelCreateEvent", "GuildChannelUpdateEvent", "GuildChannelDeleteEvent", "ChannelPinsUpdateEvent",
+    "InteractionEvent",
+
+    # models
+    "UserModel", "EmojiModel", "GuildModel", "ApplicationModel", "ReadyGuildModel", "IntegrationModel", 
+    "InteractionCallbackDataModel", "InteractionCallbackModel", "MemberModel", "RoleColors", "RoleModel",
+
+    # parts
+    "ChannelTypes", "GuildChannel",
+    "CommandTypes", "CommandOptionTypes", "SlashCommand", "UserCommand", "MessageCommand",
+    "ComponentV2Types", "SectionPart", "TextDisplay", "Thumbnail", "MediaGalleryItem", "MediaGallery",
+    "File", "SeparatorTypes", "Separator", "ContainerPart", "Label",
+    "ComponentTypes", "ActionRowPart", "ButtonStyles", "Button", "SelectOption", "StringSelect",
+    "TextInputStyles", "TextInput", "DefaultValue", "UserSelect", "RoleSelect", "MentionableSelect",
+    "ChannelSelect",
+    "EmbedAuthor", "EmbedThumbnail", "EmbedField", "EmbedImage", "EmbedFooter", "EmbedPart",
+    "MessageFlags", "MessageReferenceTypes", "MessageReference", "Attachment", "MessagePart", "Role", "ModalPart", 
+
+    # resources
+    "ApplicationFlags", "Application",
+    "BotEmojis",
+    "PinnedMessage", "Channel",
+    "Guild",
+    "InteractionCallbackTypes", "Interaction",
+    "Message",
+    "User",
+]
+
+# For editor support / autocomplete
+if TYPE_CHECKING:
+    from .logger import Logger
+    from .client import Client
+    from .intents import Intents, set_intents
+    from .config import BaseConfig
+
+    from .dispatch.command_dispatcher import InteractionTypes
+
+    # events
+    from .events.ready_event import ReadyEvent
+    from .events.reaction_events import (
+        ReactionAddEvent,
+        ReactionRemoveEvent,
+        ReactionRemoveEmojiEvent,
+        ReactionRemoveAllEvent,
+    )
+    from .events.guild_events import (
+        GuildCreateEvent,
+        GuildUpdateEvent,
+        GuildDeleteEvent,
+    )
+    from .events.message_events import (
+        MessageCreateEvent,
+        MessageUpdateEvent,
+        MessageDeleteEvent,
+    )
+    from .events.channel_events import (
+        GuildChannelCreateEvent,
+        GuildChannelUpdateEvent,
+        GuildChannelDeleteEvent,
+        ChannelPinsUpdateEvent,
+    )
+    from .events.interaction_events import InteractionEvent
+
+    # models
+    from .models import (
+        UserModel,
+        EmojiModel,
+        GuildModel,
+        ApplicationModel,
+        ReadyGuildModel,
+        IntegrationModel,
+        InteractionCallbackDataModel,
+        InteractionCallbackModel,
+        MemberModel,
+        RoleColors,
+        RoleModel
+    )
+
+    # parts
+    from .parts.channel import (
+        ChannelTypes, 
+        GuildChannel
+    )
+
+    from .parts.command import (
+        CommandTypes,
+        CommandOptionTypes,
+        SlashCommand, 
+        UserCommand,
+        MessageCommand
+    )
+
+    from .parts.components_v2 import (
+        ComponentV2Types,
+        SectionPart,
+        TextDisplay,
+        Thumbnail,
+        MediaGalleryItem,
+        MediaGallery,
+        File,
+        SeparatorTypes,
+        Separator,
+        ContainerPart,
+        Label
+    )
+
+    from .parts.components import (
+        ComponentTypes,
+        ActionRowPart, 
+        ButtonStyles,
+        Button,
+        SelectOption,
+        StringSelect,
+        TextInputStyles,
+        TextInput,
+        DefaultValue,
+        # SelectMenu,
+        UserSelect,
+        RoleSelect,
+        MentionableSelect,
+        ChannelSelect
+    )
+
+    from .parts.embed import (
+        EmbedAuthor,
+        EmbedThumbnail,
+        EmbedField,
+        EmbedImage,
+        EmbedFooter,
+        EmbedPart
+    )
+
+    from .parts.message import (
+        MessageFlags,
+        # MessageFlagParams,
+        MessageReferenceTypes,
+        MessageReference,
+        Attachment,
+        MessagePart
+    )
+
+    from .parts.modal import ModalPart
+    from .parts.role import Role
+
+    # resources
+    from .resources.application import (
+        ApplicationFlags,
+        Application
+    )
+
+    from .resources.bot_emojis import BotEmojis
+
+    from .resources.channel import (
+        # MessagesFetchParams,
+        # PinsFetchParams,
+        # ThreadFromMessageParams,
+        PinnedMessage,
+        Channel
+    )
+
+    from .resources.guild import (
+        # FetchGuildMembersParams,
+        # FetchGuildParams,
+        Guild
+    )
+
+    from .resources.interaction import (
+        # InteractionDataTypes,
+        InteractionCallbackTypes,
+        Interaction
+    )
+
+    from .resources.message import Message
+
+    from .resources.user import (
+        # FetchUserGuildsParams,
+        User
+    )
+
+_lazy_modules = [
+    # top-level modules
+    (
+        "scurrypy.logger",
+        [
+            "Logger"
+        ]
+    ),
+    (
+        "scurrypy.client",
+        [
+            "Client"
+        ]
+    ),
+    (
+        "scurrypy.intents",
+        [
+            "Intents", 
+            "set_intents"
+        ]
+    ),
+    (
+        "scurrypy.config",
+        [
+            "BaseConfig"
+        ]
+    ),
+    (
+        "scurrypy.models",
+        [
+            "UserModel",
+            "EmojiModel",
+            "GuildModel",
+            "ApplicationModel",
+            "ReadyGuildModel",
+            "IntegrationModel",
+            "InteractionCallbackDataModel",
+            "InteractionCallbackModel",
+            "MemberModel",
+            "RoleColors",
+            "RoleModel"
+        ]
+    ),
+    
+    # Events
+    (
+        "scurrypy.events.ready_event",
+        [
+            "ReadyEvent"
+        ]
+    ),
+    (
+        "scurrypy.events.reaction_events",
+        [
+            "ReactionAddEvent", 
+            "ReactionRemoveEvent", 
+            "ReactionRemoveEmojiEvent", 
+            "ReactionRemoveAllEvent"
+        ]
+    ),
+    (
+        "scurrypy.events.guild_events",
+        [
+            "GuildCreateEvent", 
+            "GuildUpdateEvent", 
+            "GuildDeleteEvent"
+        ]
+    ),
+    (
+        "scurrypy.events.message_events",
+        [
+            "MessageCreateEvent", 
+            "MessageUpdateEvent", 
+            "MessageDeleteEvent"
+        ]
+    ),
+    (
+        "scurrypy.events.channel_events",
+        [
+            "GuildChannelCreateEvent", 
+            "GuildChannelUpdateEvent", 
+            "GuildChannelDeleteEvent", 
+            "ChannelPinsUpdateEvent"
+        ]
+    ),
+    (
+        "scurrypy.events.interaction_events",
+        [
+            "InteractionEvent"
+        ]
+    ),
+
+    # Parts
+    (
+        "scurrypy.parts.channel",
+        [
+            "ChannelTypes", 
+            "GuildChannel"
+        ]
+    ),
+    (
+        "scurrypy.parts.command",
+        [
+            "CommandTypes", 
+            "CommandOptionTypes", 
+            "SlashCommand", 
+            "UserCommand", 
+            "MessageCommand"
+        ]
+    ),
+    (
+        "scurrypy.parts.components_v2",
+        [
+            "ComponentV2Types", 
+            "SectionPart", 
+            "TextDisplay", 
+            "Thumbnail", 
+            "MediaGalleryItem", 
+            "MediaGallery", 
+            "File", 
+            "SeparatorTypes", 
+            "Separator", 
+            "ContainerPart", 
+            "Label"
+        ]
+    ),
+    (
+        "scurrypy.parts.components",
+        [
+            "ComponentTypes", 
+            "ActionRowPart", 
+            "ButtonStyles", 
+            "Button", 
+            "SelectOption",
+            "StringSelect", 
+            "TextInputStyles", 
+            "TextInput", 
+            "DefaultValue", 
+            "UserSelect", 
+            "RoleSelect", 
+            "MentionableSelect",
+            "ChannelSelect"
+        ]
+    ),
+    (
+        "scurrypy.parts.embed",
+        [
+            "EmbedAuthor",
+            "EmbedThumbnail",
+            "EmbedField",
+            "EmbedImage",
+            "EmbedFooter",
+            "EmbedPart"
+        ]
+    ),
+    (
+        "scurrypy.parts.message",
+        [
+            "MessageFlags",
+            "MessageReferenceTypes",
+            "MessageReference",
+            "Attachment",
+            "MessagePart"
+        ]
+    ),
+    (
+        "scurrypy.parts.modal",
+        [
+            "ModalPart"
+        ]
+    ),
+
+    # resources
+    (
+        "scurrypy.resources.application",
+        [
+            "ApplicationFlags",
+            "Application"
+        ]
+    ),
+    (
+        "scurrypy.resources.bot_emojis",
+        [
+            "BotEmojis"
+        ]
+    ),
+    (
+        "scurrypy.resources.channel",
+        [
+            "PinnedMessage",
+            "Channel"
+        ]
+    ),
+    (
+        "scurrypy.resources.guild",
+        [
+            "Guild"
+        ]
+    ),
+    (
+        "scurrypy.resources.interaction",
+        [
+            "InteractionCallbackTypes",
+            "Interaction"
+        ]
+    ),
+    (
+        "scurrypy.resources.message",
+        [
+            "Message"
+        ]
+    ),
+    (
+        "scurrypy.resources.user",
+        [
+            "User"
+        ]
+    )
+]
+
+_mapping = {name: module_path 
+    for module_path, names in _lazy_modules 
+    for name in names
+}
+
+def __getattr__(name: str):
+    if name not in _mapping:
+        raise AttributeError(f"module {__name__} has no attribute {name}")
+
+    module = importlib.import_module(_mapping[name])
+    attr = getattr(module, name)
+    globals()[name] = attr  # cache it for future lookups
+    return attr
+
+def __dir__():
+    return sorted(list(globals().keys()) + __all__)