scurrypy 0.3.2__tar.gz → 0.3.4.1__tar.gz

scurrypy-0.3.4.1/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: scurrypy
+Version: 0.3.4.1
+Summary: Discord API Wrapper in Python
+Author: Furmissile
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# __Welcome to ScurryPy__
+
+[![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
+
+Yet another 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
+* Command and event handling
+* Declarative style using decorators
+* Supports both legacy and new features
+* Respects Discord's rate limits
+
+## Some things to consider...
+* This is an early version — feedback, ideas, and contributions are very welcome! That said, there may be bumps along the way, so expect occasional bugs and quirks.
+* Certain features are not yet supported, while others are intentionally omitted. See the [docs](https://furmissile.github.io/scurrypy) for full details.
+
+## 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.
+
+*Note: Adjust `dotenv_path` if your `.env` file is not in the same directory as this script.*
+
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env')
+
+client = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=APPLICATION_ID  # replace with your bot's user ID
+)
+
+@client.command(
+    command=discord.SlashCommand(
+        name='example',
+        description='Demonstrate the minimal slash command!'
+    ),
+    guild_id=GUILD_ID  # must be a guild ID your bot is in
+)
+async def example(bot: discord.Client, event: discord.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.
+
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env')
+
+client = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=APPLICATION_ID,  # replace with your bot's user ID
+    intents=discord.set_intents(message_content=True),
+    prefix='!'  # your custom prefix
+)
+
+@client.prefix_command
+async def ping(bot: discord.Client, event: discord.MessageCreateEvent):
+    # The function name is the name of the command
+    await event.message.send("Pong!")
+
+client.run()
+```
+
+## Like what you see?
+Check out the full [documentation](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference!

scurrypy-0.3.4.1/README.md

@@ -0,0 +1,82 @@
+# __Welcome to ScurryPy__
+
+[![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
+
+Yet another 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
+* Command and event handling
+* Declarative style using decorators
+* Supports both legacy and new features
+* Respects Discord's rate limits
+
+## Some things to consider...
+* This is an early version — feedback, ideas, and contributions are very welcome! That said, there may be bumps along the way, so expect occasional bugs and quirks.
+* Certain features are not yet supported, while others are intentionally omitted. See the [docs](https://furmissile.github.io/scurrypy) for full details.
+
+## 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.
+
+*Note: Adjust `dotenv_path` if your `.env` file is not in the same directory as this script.*
+
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env')
+
+client = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=APPLICATION_ID  # replace with your bot's user ID
+)
+
+@client.command(
+    command=discord.SlashCommand(
+        name='example',
+        description='Demonstrate the minimal slash command!'
+    ),
+    guild_id=GUILD_ID  # must be a guild ID your bot is in
+)
+async def example(bot: discord.Client, event: discord.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.
+
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env')
+
+client = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=APPLICATION_ID,  # replace with your bot's user ID
+    intents=discord.set_intents(message_content=True),
+    prefix='!'  # your custom prefix
+)
+
+@client.prefix_command
+async def ping(bot: discord.Client, event: discord.MessageCreateEvent):
+    # The function name is the name of the command
+    await event.message.send("Pong!")
+
+client.run()
+```
+
+## Like what you see?
+Check out the full [documentation](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference!

scurrypy-0.3.4.1/discord/__init__.py

@@ -0,0 +1,223 @@
+# discord
+
+import importlib
+from typing import TYPE_CHECKING
+
+__all__ = [
+    # top-level
+    "Logger",
+    "Client",
+    "Intents",
+    "set_intents",
+    "BaseConfig",
+
+    # events
+    "ReadyEvent",
+    "ReactionAddEvent",
+    "ReactionRemoveEvent",
+    "ReactionRemoveEmojiEvent",
+    "ReactionRemoveAllEvent",
+    "GuildCreateEvent",
+    "GuildUpdateEvent",
+    "GuildDeleteEvent",
+    "MessageCreateEvent",
+    "MessageUpdateEvent",
+    "MessageDeleteEvent",
+    "GuildChannelCreateEvent",
+    "GuildChannelUpdateEvent",
+    "GuildChannelDeleteEvent",
+    "ChannelPinsUpdateEvent",
+    "InteractionEvent",
+
+    # models
+    "ApplicationModel",
+    "EmojiModel",
+    "GuildModel",
+    "MemberModel",
+    "UserModel",
+    "RoleModel",
+
+    # parts
+    "GuildChannel",
+    "Role",
+    "MessageBuilder",
+    "ModalBuilder",
+    "EmbedBuilder",
+    "ActionRow",
+    "StringSelect",
+    "UserSelect",
+    "RoleSelect",
+    "ChannelSelect",
+    "MentionableSelect",
+    "SlashCommand",
+    "MessageCommand",
+    "UserCommand",
+    "Container",
+    "Section",
+    "MediaGalleryItem",
+    "Label",
+
+    # resources
+    "Guild",
+    "Channel",
+    "Message",
+    "BotEmojis",
+    "User",
+    "Interaction",
+    "Application",
+]
+
+# 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
+
+    # 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.application import ApplicationModel
+    from .models.emoji import EmojiModel
+    from .models.guild import GuildModel
+    from .models.member import MemberModel
+    from .models.user import UserModel
+    from .models.role import RoleModel
+
+    # parts
+    from .parts.channel import GuildChannel
+    from .parts.role import Role
+    from .parts.message import MessageBuilder
+    from .parts.modal import ModalBuilder
+    from .parts.embed import EmbedBuilder
+    from .parts.action_row import (
+        ActionRow, 
+        StringSelect,
+        UserSelect,
+        RoleSelect,
+        ChannelSelect,
+        MentionableSelect
+    )
+
+    from .parts.command import (
+        SlashCommand, 
+        MessageCommand, 
+        UserCommand
+    )
+
+    from .parts.components_v2 import (
+        Container,
+        Section,
+        MediaGalleryItem,
+        Label
+    )
+
+    # resources
+    from .resources.guild import Guild
+    from .resources.channel import Channel
+    from .resources.message import Message
+    from .resources.bot_emojis import BotEmojis
+    from .resources.user import User
+    from .resources.interaction import Interaction
+    from .resources.application import Application
+
+# Lazy loader
+def __getattr__(name: str):
+    if name not in __all__:
+        raise AttributeError(f"module {__name__} has no attribute {name}")
+
+    mapping = {
+        # top-level
+        "Logger": "discord.logger",
+        "Client": "discord.client",
+        "Intents": "discord.intents",
+        "set_intents": "discord.intents",
+        "BaseConfig": "discord.config",
+
+        # events
+        "ReadyEvent": "discord.events.ready_event",
+        "ReactionAddEvent": "discord.events.reaction_events",
+        "ReactionRemoveEvent": "discord.events.reaction_events",
+        "ReactionRemoveEmojiEvent": "discord.events.reaction_events",
+        "ReactionRemoveAllEvent": "discord.events.reaction_events",
+        "GuildCreateEvent": "discord.events.guild_events",
+        "GuildUpdateEvent": "discord.events.guild_events",
+        "GuildDeleteEvent": "discord.events.guild_events",
+        "MessageCreateEvent": "discord.events.message_events",
+        "MessageUpdateEvent": "discord.events.message_events",
+        "MessageDeleteEvent": "discord.events.message_events",
+        "GuildChannelCreateEvent": "discord.events.channel_events",
+        "GuildChannelUpdateEvent": "discord.events.channel_events",
+        "GuildChannelDeleteEvent": "discord.events.channel_events",
+        "ChannelPinsUpdateEvent": "discord.events.channel_events",
+        "InteractionEvent": "discord.events.interaction_events",
+
+        # models
+        'ApplicationModel': "discord.models.application",
+        'EmojiModel': "discord.models.emoji",
+        'GuildModel': "discord.models.guild",
+        'MemberModel': "discord.models.member",
+        'UserModel': "discord.models.user",
+        'RoleModel': "discord.models.role",
+
+        # parts
+        'GuildChannel': "discord.parts.channel",
+        'Role': "discord.parts.role",
+        'MessageBuilder': "discord.parts.message",
+        'ModalBuilder': "discord.parts.modal",
+        'EmbedBuilder': "discord.parts.embed",
+        'ActionRow': "discord.parts.action_row",
+        'StringSelect': "discord.parts.action_row",
+        'UserSelect': "discord.parts.action_row",
+        'RoleSelect': "discord.parts.action_row",
+        'ChannelSelect': "discord.parts.action_row",
+        'MentionableSelect': "discord.parts.action_row",
+        'SlashCommand': "discord.parts.command",
+        'MessageCommand': "discord.parts.command",
+        'UserCommand': "discord.parts.command",
+        'Container': "discord.parts.components_v2",
+        'Section': "discord.parts.components_v2",
+        'MediaGalleryItem': "discord.parts.components_v2",
+        'Label': "discord.parts.components_v2",
+
+        # resources
+        'Guild': "discord.resources.guild",
+        'Channel': "discord.resources.channel",
+        'Message': "discord.resources.message",
+        'BotEmojis': "discord.resources.bot_emojis",
+        'User': "discord.resources.user",
+        'Interaction': "discord.resources.interaction",
+        'Application': "discord.resources.application"
+    }
+
+    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__)