scurrypy 0.1.0__tar.gz → 0.2.1__tar.gz

scurrypy-0.2.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: scurrypy
+Version: 0.2.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
+
+## Something things to consider...
+* This is an early version — feedback, ideas, and contributions are welcome! With that said, there will be bumps in the road so expect bugs and other flaws!
+* Some features are not yet supported, such as sharding and automod, while others, like voice, will never be supported. While this library can handle many of your basic needs, common features such as sharding or auto-mod actions are not yet implemented. See the [license](LICENSE) for details on usage.
+
+
+## Getting Started
+While this tab shows up in the docs, here are some complete examples where all you need to do is pop in your bot's 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.
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env') # omit argument if your env file is on the same level
+
+bot = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=1234567890 # replace with your bot's user ID
+)
+
+@bot.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(event: discord.InteractionEvent):
+    await event.interaction.respond(f'Hello, {event.interaction.member.user.username}!')
+
+bot.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') # omit argument if your env file is on the same level
+
+bot = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=1234567890, # replace with your bot's user ID
+    intents=discord.set_intents(message_content=True),
+    prefix='!' # your custom prefix
+)
+
+@bot.prefix_command
+async def ping(event: discord.MessageCreateEvent): # the function name is the name of the command!
+    await event.message.send(f"Pong!")
+
+bot.run()
+```
+
+## Like what you see?
+See the docs for more!

scurrypy-0.2.1/README.md

@@ -0,0 +1,75 @@
+# __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
+
+## Something things to consider...
+* This is an early version — feedback, ideas, and contributions are welcome! With that said, there will be bumps in the road so expect bugs and other flaws!
+* Some features are not yet supported, such as sharding and automod, while others, like voice, will never be supported. While this library can handle many of your basic needs, common features such as sharding or auto-mod actions are not yet implemented. See the [license](LICENSE) for details on usage.
+
+
+## Getting Started
+While this tab shows up in the docs, here are some complete examples where all you need to do is pop in your bot's 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.
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env') # omit argument if your env file is on the same level
+
+bot = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=1234567890 # replace with your bot's user ID
+)
+
+@bot.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(event: discord.InteractionEvent):
+    await event.interaction.respond(f'Hello, {event.interaction.member.user.username}!')
+
+bot.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') # omit argument if your env file is on the same level
+
+bot = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=1234567890, # replace with your bot's user ID
+    intents=discord.set_intents(message_content=True),
+    prefix='!' # your custom prefix
+)
+
+@bot.prefix_command
+async def ping(event: discord.MessageCreateEvent): # the function name is the name of the command!
+    await event.message.send(f"Pong!")
+
+bot.run()
+```
+
+## Like what you see?
+See the docs for more!

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/__init__.py

@@ -3,6 +3,7 @@
 from .logger import Logger
 from .client import Client
 from .intents import Intents, set_intents
+from .config import BaseConfig
 
 from .events import *
 from .resources import *

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/client.py

@@ -5,6 +5,7 @@ from .gateway import GatewayClient
 from .http import HTTPClient
 from .intents import Intents
 from .error import DiscordError
+from .config import BaseConfig
 
 from .resources.guild import Guild
 from .resources.channel import Channel
@@ -28,6 +29,7 @@ class Client:
         token: str,
         application_id: int,
         intents: int = Intents.DEFAULT,
+        config: BaseConfig = None,
         debug_mode: bool = False,
         prefix = None,
         quiet: bool = False
@@ -43,6 +45,7 @@ class Client:
         """
         self.token = token
         self.application_id = application_id
+        self.config = config
 
         self._logger = Logger(debug_mode, quiet)
         self._ws = GatewayClient(token, intents, self._logger)
@@ -51,15 +54,16 @@ class Client:
         if prefix and (intents & Intents.MESSAGE_CONTENT == 0):
             self._logger.log_warn('Prefix set without message content enabled.')
 
-        self.dispatcher = EventDispatcher(self.application_id, self._http, self._logger)
-        self.prefix_dispatcher = PrefixDispatcher(self._http, self._logger, prefix)
-        self.command_dispatcher = CommandDispatcher(self.application_id, self._http, self._logger)
+        self.dispatcher = EventDispatcher(self.application_id, self._http, self._logger, config)
+        self.prefix_dispatcher = PrefixDispatcher(self._http, self._logger, prefix, config)
+        self.command_dispatcher = CommandDispatcher(self.application_id, self._http, self._logger, config)
 
         self._global_commands = [] # SlashCommand
         self._guild_commands = {} # {guild_id : [commands], ...}
 
         self._is_set_up = False
         self._setup_hooks = []
+        self._shutdown_hooks = []
         
         self.emojis = BotEmojis(self._http, self.application_id)
 
@@ -125,6 +129,15 @@ class Client:
         """
         self._setup_hooks.append(func)
 
+    def shutdown_hook(self, func):
+        """Decorator registers a shutdown hook.
+            (Runs once before the bot exits the loop)
+
+        Args:
+            func (callable): callback to the shutdown function
+        """
+        self._shutdown_hooks.append(func)
+
     def application_from_id(self, application_id: int):
         """Creates an interactable application resource.
 
@@ -265,7 +278,7 @@ class Client:
                     if self._setup_hooks:
                         for hook in self._setup_hooks:
                             self._logger.log_info(f"Setting hook {hook.__name__}")
-                            await hook()
+                            await hook(self)
                         self._logger.log_high_priority("Hooks set up.")
 
                     # register GUILD commands
@@ -293,8 +306,25 @@ class Client:
                 self._logger.log_error(f"Unspecified Error Type {type(e).__name__} - {e}")
                 break
             finally:
-                await self._ws.close()
-                await self._http.close_session()
+                # Run hooks (with safe catching)
+                for hook in self._shutdown_hooks:
+                    try:
+                        self._logger.log_info(f"Executing shutdown hook {hook.__name__}")
+                        await hook(self)
+                    except Exception as e:
+                        self._logger.log_error(f"{type(e).__name__}: {e}")
+
+                # Always close resources
+                try:
+                    await self._ws.close()
+                except Exception as e:
+                    self._logger.log_warn(f"WebSocket close failed: {e}")
+
+                try:
+                    await self._http.close_session()
+                except Exception as e:
+                    self._logger.log_warn(f"HTTP session close failed: {e}")
+
 
     def run(self):
         """Starts the bot.

scurrypy-0.2.1/discord/config.py

@@ -0,0 +1,6 @@
+from dataclasses import dataclass
+
+@dataclass
+class BaseConfig:
+    """Config class that lives inside Client and can be extended by the dev to add persistent data (like a database)."""
+    pass

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/dispatch/command_dispatcher.py

@@ -2,6 +2,7 @@ import asyncio
 
 from ..http import HTTPClient
 from ..logger import Logger
+from ..config import BaseConfig
 
 from ..events.interaction_events import ApplicationCommandData, MessageComponentData, ModalData, InteractionEvent
 from ..resources.interaction import Interaction, InteractionDataTypes
@@ -28,7 +29,7 @@ class CommandDispatcher:
     }
     """Maps [`InteractionTypes`][discord.dispatch.command_dispatcher.InteractionTypes] to their respective dataclass."""
 
-    def __init__(self, application_id: int, http: HTTPClient, logger: Logger):
+    def __init__(self, application_id: int, http: HTTPClient, logger: Logger, config: BaseConfig):
         self.application_id = application_id
         """Bot's application ID."""
 
@@ -38,6 +39,8 @@ class CommandDispatcher:
         self._logger = logger
         """Logger instance to log events."""
 
+        self.config = config
+
         self._component_handlers = {}
         """Mapping of component custom IDs to handler."""
 
@@ -114,7 +117,7 @@ class CommandDispatcher:
         Args:
             data (dict): interaction data
         """
-        event = InteractionEvent(interaction=Interaction.from_dict(data, self._http))
+        event = InteractionEvent(config=self.config, interaction=Interaction.from_dict(data, self._http))
 
         event_data_obj = self.RESOURCE_MAP.get(event.interaction.type)
 

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/dispatch/event_dispatcher.py

@@ -1,5 +1,6 @@
 from ..http import HTTPClient
 from ..logger import Logger
+from ..config import BaseConfig
 
 from ..events.ready_event import *
 from ..events.reaction_events import *
@@ -40,7 +41,7 @@ class EventDispatcher:
     }
     """Mapping of event names to respective dataclass."""
     
-    def __init__(self, application_id: int, http: HTTPClient, logger: Logger):
+    def __init__(self, application_id: int, http: HTTPClient, logger: Logger, config: BaseConfig):
         self.application_id = application_id
         """Bot's ID."""
 
@@ -50,6 +51,9 @@ class EventDispatcher:
         self._logger = logger
         """HTTP session for requests"""
 
+        self.config = config
+        """User-defined bot config for persistent data."""
+
         self._handlers = {}
         """Mapping of event names to handler."""
 
@@ -81,5 +85,6 @@ class EventDispatcher:
         handler = self._handlers.get(event_name, None)
         if handler:
             obj = cls.from_dict(data, self._http)
+            obj.config = self.config
             await handler(obj)
             self._logger.log_info(f"Event {event_name} Acknowledged.")

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/dispatch/prefix_dispatcher.py

@@ -1,5 +1,6 @@
 from ..http import HTTPClient
 from ..logger import Logger
+from ..config import BaseConfig
 
 from ..events.message_events import MessageCreateEvent
 
@@ -8,7 +9,7 @@ from ..models.member import MemberModel
 
 class PrefixDispatcher:
     """Handles text-based command messages that start with a specific prefix."""
-    def __init__(self, http: HTTPClient, logger: Logger, prefix: str):
+    def __init__(self, http: HTTPClient, logger: Logger, prefix: str, config: BaseConfig):
         self._http = http
         """HTTP session for requests."""
 
@@ -18,6 +19,9 @@ class PrefixDispatcher:
         self.prefix = prefix
         """User-defined command prefix."""
 
+        self.config = config
+        """User-defined bot config for persistent data."""
+
         self._handlers = {}
         """Mapping of command prefix names to handler"""
 
@@ -37,6 +41,7 @@ class PrefixDispatcher:
             data (dict): Discord's raw event payload
         """
         event = MessageCreateEvent(
+            config=self.config,
             guild_id=data.get('guild_id'),
             message=Message.from_dict(data, self._http),
             member=MemberModel.from_dict(data.get('member'))

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/events/channel_events.py

@@ -1,10 +1,11 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 
 @dataclass
-class GuildChannelEvent(DataModel):
+class GuildChannelEvent(EventModel):
     """Base guild channel event."""
+
     id: int
     """ID of the guild channel."""
 
@@ -45,7 +46,7 @@ class GuildChannelDeleteEvent(GuildChannelEvent):
     pass
 
 @dataclass
-class ChannelPinsUpdateEvent(DataModel):
+class ChannelPinsUpdateEvent(EventModel):
     """Pin update event."""
     channel_id: int
     guild_id: Optional[int]

scurrypy-0.2.1/discord/events/event_model.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from ..model import DataModel
+from ..config import BaseConfig
+
+@dataclass
+class EventModel(DataModel):
+    """Event Model for event-driven fields common among all events."""
+
+    config: BaseConfig
+    """User-defined bot config for persistent data."""

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/events/guild_events.py

@@ -1,11 +1,10 @@
 from dataclasses import dataclass
-from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 from ..models import MemberModel
 from ..resources.channel import Channel
 
 @dataclass
-class GuildEvent(DataModel):
+class GuildEvent(EventModel):
     """Base guild event."""
     joined_at: str
     """ISO8601 timestamp of when app joined the guild."""
@@ -22,9 +21,6 @@ class GuildEvent(DataModel):
     channels: list[Channel]
     """Channels in the guild."""
 
-    unavailable: Optional[bool]
-    """If the guild is unavailable due to an outage."""
-
 class GuildCreateEvent(GuildEvent):
     """Received when the bot has joined a guild."""
     pass

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/events/interaction_events.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass, field
 from typing import Optional
 from ..model import DataModel
+from ..config import BaseConfig
 
 from ..resources.interaction import Interaction
 
@@ -141,5 +142,8 @@ class InteractionEvent(DataModel):
     interaction: Interaction
     """Interaction resource object. See [`Interaction`][discord.resources.interaction.Interaction]."""
 
+    config: BaseConfig
+    """User-defined bot config for persistent data."""
+
     data: Optional[ApplicationCommandData | MessageComponentData | ModalData] = None
     """Interaction response data."""

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/events/message_events.py

@@ -1,12 +1,12 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 
 from ..resources.message import Message
 from ..models.member import MemberModel
 
 @dataclass
-class MessageCreateEvent(DataModel):
+class MessageCreateEvent(EventModel):
     """Received when a message is created."""
     message: Message
     """Message resource object. See [`Resource.Message`][discord.resources.message.Message]."""
@@ -18,7 +18,7 @@ class MessageCreateEvent(DataModel):
     """Partial Member object of the author of the message. See [`MemberModel`][discord.models.member.MemberModel]."""
     
 @dataclass
-class MessageUpdateEvent(DataModel):
+class MessageUpdateEvent(EventModel):
     """Received when a message is updated."""
     message: Message
     """Message resource object. See [`Resource.Message`][discord.resources.message.Message]."""
@@ -30,7 +30,7 @@ class MessageUpdateEvent(DataModel):
     """Partial Member object of the author of the message. See [`MemberModel`][discord.models.member.MemberModel]."""
 
 @dataclass
-class MessageDeleteEvent(DataModel):
+class MessageDeleteEvent(EventModel):
     """Received when a message is deleted."""
 
     id: int

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/events/reaction_events.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 
 from ..models.member import MemberModel
 from ..models.emoji import EmojiModel
@@ -15,7 +15,7 @@ class ReactionType:
     """A super emoji."""
 
 @dataclass
-class ReactionAddEvent(DataModel):
+class ReactionAddEvent(EventModel):
     """Reaction added event."""
 
     type: int
@@ -46,7 +46,7 @@ class ReactionAddEvent(DataModel):
     """ID of the user who sent the message where the reaction was added."""
 
 @dataclass
-class ReactionRemoveEvent(DataModel):
+class ReactionRemoveEvent(EventModel):
     """Reaction removed event."""
 
     type: int
@@ -70,7 +70,7 @@ class ReactionRemoveEvent(DataModel):
     burst: bool
     """If the emoji of the removed reaction is super."""
 
-class ReactionRemoveAllEvent(DataModel):
+class ReactionRemoveAllEvent(EventModel):
     """Remove all reactions event."""
 
     channel_id: int
@@ -83,7 +83,7 @@ class ReactionRemoveAllEvent(DataModel):
     """ID of the guild where all reaction were removed (if in a guild)."""
 
 @dataclass
-class ReactionRemoveEmojiEvent(DataModel):
+class ReactionRemoveEmojiEvent(EventModel):
     """All reactions of a specific emoji removed."""
 
     emoji: EmojiModel

{scurrypy-0.1.0 → scurrypy-0.2.1}/discord/events/ready_event.py

@@ -1,5 +1,7 @@
 from dataclasses import dataclass
 from ..model import DataModel
+from ..config import BaseConfig
+
 from ..models.user import UserModel
 from ..models.guild import ReadyGuildModel
 from ..models.application import ApplicationModel
@@ -28,3 +30,6 @@ class ReadyEvent(DataModel):
 
     application: ApplicationModel
     """Partial application object. Contains ID and flags."""
+
+    config: BaseConfig
+    """User-defined bot config for persistent data."""

{scurrypy-0.1.0 → scurrypy-0.2.1}/pyproject.toml

@@ -4,9 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scurrypy"
-version = "0.1.0"
+version = "0.2.1"
 
 description = "Discord API Wrapper in Python"
+readme = "README.md"
 authors = [{ name = "Furmissile" }]
 requires-python = ">=3.10"
 dependencies = []

scurrypy-0.2.1/scurrypy.egg-info/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: scurrypy
+Version: 0.2.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
+
+## Something things to consider...
+* This is an early version — feedback, ideas, and contributions are welcome! With that said, there will be bumps in the road so expect bugs and other flaws!
+* Some features are not yet supported, such as sharding and automod, while others, like voice, will never be supported. While this library can handle many of your basic needs, common features such as sharding or auto-mod actions are not yet implemented. See the [license](LICENSE) for details on usage.
+
+
+## Getting Started
+While this tab shows up in the docs, here are some complete examples where all you need to do is pop in your bot's 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.
+```python
+import discord, os
+from dotenv import load_dotenv
+
+load_dotenv(dotenv_path='./path/to/env') # omit argument if your env file is on the same level
+
+bot = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=1234567890 # replace with your bot's user ID
+)
+
+@bot.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(event: discord.InteractionEvent):
+    await event.interaction.respond(f'Hello, {event.interaction.member.user.username}!')
+
+bot.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') # omit argument if your env file is on the same level
+
+bot = discord.Client(
+    token=os.getenv("DISCORD_TOKEN"),
+    application_id=1234567890, # replace with your bot's user ID
+    intents=discord.set_intents(message_content=True),
+    prefix='!' # your custom prefix
+)
+
+@bot.prefix_command
+async def ping(event: discord.MessageCreateEvent): # the function name is the name of the command!
+    await event.message.send(f"Pong!")
+
+bot.run()
+```
+
+## Like what you see?
+See the docs for more!

{scurrypy-0.1.0 → scurrypy-0.2.1}/scurrypy.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 discord/__init__.py
 discord/client.py
+discord/config.py
 discord/error.py
 discord/gateway.py
 discord/http.py
@@ -15,6 +16,7 @@ discord/dispatch/event_dispatcher.py
 discord/dispatch/prefix_dispatcher.py
 discord/events/__init__.py
 discord/events/channel_events.py
+discord/events/event_model.py
 discord/events/guild_events.py
 discord/events/hello_event.py
 discord/events/interaction_events.py

scurrypy-0.1.0/PKG-INFO

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: scurrypy
-Version: 0.1.0
-Summary: Discord API Wrapper in Python
-Author: Furmissile
-Requires-Python: >=3.10
-License-File: LICENSE
-Dynamic: license-file

scurrypy-0.1.0/README.md

@@ -1,12 +0,0 @@
-# __Welcome to 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
-
-See the docs for more!

scurrypy-0.1.0/scurrypy.egg-info/PKG-INFO

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: scurrypy
-Version: 0.1.0
-Summary: Discord API Wrapper in Python
-Author: Furmissile
-Requires-Python: >=3.10
-License-File: LICENSE
-Dynamic: license-file