scurrypy 0.6.5__tar.gz → 0.7.2__tar.gz

{scurrypy-0.6.5/scurrypy.egg-info → scurrypy-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scurrypy
-Version: 0.6.5
+Version: 0.7.2
 Summary: Dataclass-driven Discord API Wrapper in Python
 Author: Furmissile
 Requires-Python: >=3.10
@@ -10,16 +10,17 @@ Requires-Dist: aiohttp>=3.8.0
 Requires-Dist: websockets>=11.0.0
 Dynamic: license-file
 
-# __ScurryPy__
+## __<center> ScurryPy </center>__
 
 [![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
 
-A dataclass-driven Discord API wrapper in Python!
+A lightweight, fully readable Discord API framework built to accommodate everything from basic bots to custom frameworks.
 
-While this wrapper is mainly used for various squirrel-related shenanigans, it can also be used for more generic bot purposes.
+While ScurryPy powers many squirrel-related shenanigans, it works just as well for game bots, interactive components, and educational projects.
 
 ## Features
-* Easy to extend
+* Easy to extend and build frameworks on top
+* Lightweight core (<1000 lines)
 * Command, and event handling
 * Unix shell-style wildcards for component routing
 * Declarative style using decorators
@@ -28,29 +29,6 @@ While this wrapper is mainly used for various squirrel-related shenanigans, it c
 * 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.*
@@ -106,5 +84,31 @@ async def on_ping(bot: scurrypy.Client, event: scurrypy.MessageCreateEvent):
 client.run()
 ```
 
+## Building on Top of ScurryPy
+
+ScurryPy is designed to be easy to extend with your own abstractions.
+
+The following demonstrates integrating a custom cache into your client configuration:
+
+```py
+class CacheProtocol(Protocol):
+    async def get_user(self, user_id: int) ...
+
+    # and the rest...
+
+class MyCache(CacheProtocol):
+    # your implementation...
+
+class MyConfig(BaseConfig):
+    cache: MyCache
+    # other stuff here...
+
+client = scurrypy.Client(
+    token = 'your-token',
+    application_id = 123456789012345,
+    config = MyConfig()
+)
+```
+
 ## Like What You See?
 Explore the full [documentation](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference.

{scurrypy-0.6.5 → scurrypy-0.7.2}/README.md

@@ -1,13 +1,14 @@
-# __ScurryPy__
+## __<center> ScurryPy </center>__
 
 [![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
 
-A dataclass-driven Discord API wrapper in Python!
+A lightweight, fully readable Discord API framework built to accommodate everything from basic bots to custom frameworks.
 
-While this wrapper is mainly used for various squirrel-related shenanigans, it can also be used for more generic bot purposes.
+While ScurryPy powers many squirrel-related shenanigans, it works just as well for game bots, interactive components, and educational projects.
 
 ## Features
-* Easy to extend
+* Easy to extend and build frameworks on top
+* Lightweight core (<1000 lines)
 * Command, and event handling
 * Unix shell-style wildcards for component routing
 * Declarative style using decorators
@@ -16,29 +17,6 @@ While this wrapper is mainly used for various squirrel-related shenanigans, it c
 * 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.*
@@ -94,5 +72,31 @@ async def on_ping(bot: scurrypy.Client, event: scurrypy.MessageCreateEvent):
 client.run()
 ```
 
+## Building on Top of ScurryPy
+
+ScurryPy is designed to be easy to extend with your own abstractions.
+
+The following demonstrates integrating a custom cache into your client configuration:
+
+```py
+class CacheProtocol(Protocol):
+    async def get_user(self, user_id: int) ...
+
+    # and the rest...
+
+class MyCache(CacheProtocol):
+    # your implementation...
+
+class MyConfig(BaseConfig):
+    cache: MyCache
+    # other stuff here...
+
+client = scurrypy.Client(
+    token = 'your-token',
+    application_id = 123456789012345,
+    config = MyConfig()
+)
+```
+
 ## Like What You See?
 Explore the full [documentation](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference.

{scurrypy-0.6.5 → scurrypy-0.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scurrypy"
-version = "0.6.5"
+version = "0.7.2"
 
 description = "Dataclass-driven Discord API Wrapper in Python"
 readme = "README.md"
@@ -21,5 +21,7 @@ packages = [
   "scurrypy.dispatch",
   "scurrypy.events",
   "scurrypy.resources",
-  "scurrypy.parts"
+  "scurrypy.parts", 
+  "scurrypy.core",
+  "scurrypy.models"
 ]

scurrypy-0.7.2/scurrypy/__init__.py

@@ -0,0 +1,16 @@
+# scurrypy
+
+from .client import Client
+
+__all__ = [
+    # top-level modules
+    "Client"
+]
+
+# imports listed  __all__ libs
+from .events import *
+from .parts import *
+from .resources import *
+from .dispatch import *
+from .models import *
+from .core import *

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/client.py

@@ -1,9 +1,9 @@
 import asyncio
 
-from .config import BaseConfig
-from .intents import Intents
-from .gateway import GatewayClient
-from .client_like import ClientLike
+from .core.config import BaseConfig
+from .core.intents import Intents
+from .core.gateway import GatewayClient
+from .core.client_like import ClientLike
 
 from .parts.command import SlashCommand, MessageCommand, UserCommand
 
@@ -18,6 +18,7 @@ class Client(ClientLike):
         intents: int = Intents.DEFAULT,
         config: BaseConfig = None,
         debug_mode: bool = False,
+        sync_commands: bool = True,
         prefix = None,
         quiet: bool = False
     ):
@@ -27,6 +28,7 @@ class Client(ClientLike):
             application_id (int): the bot's user ID
             intents (int, optional): gateway intents. Defaults to Intents.DEFAULT.
             config (BaseConfig, optional): user-defined config data
+            sync_commands (bool, optional): toggle registering commands. Defaults to True.
             debug_mode (bool, optional): toggle debug messages. Defaults to False.
             prefix (str, optional): set message prefix if using command prefixes
             quiet (bool, optional): if INFO, DEBUG, and WARN should be logged
@@ -36,8 +38,8 @@ class Client(ClientLike):
         if not application_id:
             raise ValueError("Application ID is required")
         
-        from .logger import Logger
-        from .http import HTTPClient
+        from .core.logger import Logger
+        from .core.http import HTTPClient
         from .resources.bot_emojis import BotEmojis
         from .dispatch.event_dispatcher import EventDispatcher
         from .dispatch.prefix_dispatcher import PrefixDispatcher
@@ -47,6 +49,7 @@ class Client(ClientLike):
         self.intents = intents
         self.application_id = application_id
         self.config = config
+        self.sync_commands = sync_commands
 
         self._logger = Logger(debug_mode, quiet)
         
@@ -282,11 +285,12 @@ class Client(ClientLike):
                     await hook(self)
                 self._logger.log_high_priority("Hooks set up.")
 
-            await self.command_dispatcher.register_guild_commands()
+            if self.sync_commands:
+                await self.command_dispatcher.register_guild_commands()
 
-            await self.command_dispatcher.register_global_commands()
+                await self.command_dispatcher.register_global_commands()
 
-            self._logger.log_high_priority("Commands set up.")
+                self._logger.log_high_priority("Commands set up.")
 
             tasks = await asyncio.create_task(self._start_shards())
 

scurrypy-0.7.2/scurrypy/core/__init__.py

@@ -0,0 +1,16 @@
+# scurrypy/core
+
+# from .client_like import ClientLike
+from .config import BaseConfig
+# from .error import DiscordError
+# from .gateway import GatewayClient
+# from .http import HTTPClient
+from .intents import Intents, set_intents
+from .logger import Logger
+# from .model import DataModel
+
+__all__ = [
+    "BaseConfig",
+    "Intents", 'set_intents',
+    "Logger"
+]

{scurrypy-0.6.5/scurrypy → scurrypy-0.7.2/scurrypy/core}/http.py

@@ -171,54 +171,6 @@ class HTTPClient:
         bucket.sleep_task = None
         self.logger.log_high_priority(f"Bucket {endpoint} reset after {bucket.reset_after}s")
 
-    async def _make_payload(self, data: dict, files: list):
-        """Return (data, headers) for aiohttp request — supports multipart.
-
-        Args:
-            data (dict): request data
-            files (list): relevant files
-
-        Returns:
-            (tuple[aiohttp.FormData, dict]): form data and headers
-        """
-        headers = {}
-        if not files:
-            return data, headers
-
-        form = aiohttp.FormData()
-        if data:
-            form.add_field("payload_json", json.dumps(data))
-
-        for idx, file_path in enumerate(files):
-            async with aiofiles.open(file_path, 'rb') as f:
-                data = await f.read()
-                form.add_field(
-                    f'files[{idx}]',
-                    data,
-                    filename=file_path.split('/')[-1],
-                    content_type='application/octet-stream'
-                )
-
-        return form, headers
-
-    async def _prepare_payload(self, item: RequestItem):
-        """Prepares the payload based on `RequestItem`.
-
-        Args:
-            item (RequestItem): the request object
-
-        Returns:
-            (dict): kwargs to pass to session.request
-        """
-        kwargs = {}
-        if item.files and any(item.files):
-            payload, headers = await self._make_payload(item.data, item.files)
-            kwargs = {"data": payload, "headers": headers}
-        else:
-            kwargs = {"json": item.data}
-    
-        return kwargs
-    
     async def _check_global_rate_limit(self):
         """Checks if the global rate limit is after now (active)."""
         now = asyncio.get_event_loop().time()
@@ -291,6 +243,34 @@ class HTTPClient:
             elif bucket.sleep_task and not bucket.sleep_task.done():
                 await bucket.sleep_task
 
+    async def _prepare_payload(self, item: RequestItem):
+        """Prepares the payload based on `RequestItem`.
+
+        Args:
+            item (RequestItem): the request object
+
+        Returns:
+            (dict): kwargs to pass to session.request
+        """
+        if item.files and any(item.files):
+            # payload = await self._make_payload(item.data, item.files)
+            form = aiohttp.FormData()
+            form.add_field("payload_json", json.dumps(item.data))
+
+            for idx, file_path in enumerate(item.files):
+                async with aiofiles.open(file_path, 'rb') as f:
+                    f_data = await f.read()
+                    form.add_field(
+                        f'files[{idx}]',
+                        f_data,
+                        filename=file_path.split('/')[-1],
+                        content_type='application/octet-stream'
+                    )
+
+            return {"data": form}
+
+        return {"json": item.data}
+
     async def _send(self, item: RequestItem):
         """Core HTTP request executor.
 
@@ -312,25 +292,19 @@ class HTTPClient:
 
         kwargs = await self._prepare_payload(item)
 
-        # --- SEND REQUEST ---
-
         url = f"{self.BASE.rstrip('/')}/{item.endpoint.lstrip('/')}"
         
         async with self.session.request(
             method=item.method, url=url, params=item.params, timeout=15, **kwargs
         ) as resp:
 
-            # Update global rate limit if triggered
             if resp.headers.get("X-RateLimit-Global") == "true":
                 retry_after = float(resp.headers.get("Retry-After", 0))
                 self.global_reset = asyncio.get_event_loop().time() + retry_after
 
-            # Bucket handling (endpoint-specific rate limits)
             bucket_id = resp.headers.get('x-ratelimit-bucket')
 
             if bucket_id:
-                # grab lock from dict of bucket locks with a lock on dict access
                 await self._update_bucket_rate_limit(resp, bucket_id, item.endpoint)
 
-            # Handle response
             return await self._parse_response(resp)

{scurrypy-0.6.5/scurrypy → scurrypy-0.7.2/scurrypy/core}/intents.py

@@ -54,7 +54,7 @@ class IntentFlagParams(TypedDict, total=False):
     message_content: bool
 
 def set_intents(**flags: Unpack[IntentFlagParams]):
-    """Set bot intents. See [`Intents`][scurrypy.intents.Intents]  
+    """Set bot intents. See [`Intents`][scurrypy.core.intents.Intents]  
     `Intents.DEFAULT` = (GUILDS | GUILD_MESSAGES) will also be set.
 
     Args:

scurrypy-0.7.2/scurrypy/dispatch/__init__.py

@@ -0,0 +1,7 @@
+# scurrypy/dispatch
+
+from .command_dispatcher import InteractionTypes
+
+__all__ = [
+    "InteractionTypes"
+]

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/dispatch/command_dispatcher.py

@@ -1,6 +1,6 @@
 import fnmatch
 
-from ..client_like import ClientLike
+from ..core.client_like import ClientLike
 
 from ..events.interaction_events import ApplicationCommandData, MessageComponentData, ModalData, InteractionEvent
 from ..resources.interaction import Interaction, InteractionDataTypes

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/dispatch/event_dispatcher.py

@@ -1,5 +1,5 @@
 import importlib
-from ..client_like import ClientLike
+from ..core.client_like import ClientLike
 
 from ..resources.message import Message
 
@@ -12,6 +12,8 @@ class EventDispatcher:
         'GUILD_CREATE': ('scurrypy.events.guild_events', 'GuildCreateEvent'),
         'GUILD_UPDATE': ('scurrypy.events.guild_events', 'GuildUpdateEvent'),
         'GUILD_DELETE': ('scurrypy.events.guild_events', 'GuildDeleteEvent'),
+        'GUILD_MEMBER_ADD': ('scurrypy.events.guild_events', 'GuildMemberAddEvent'),
+        'GUILD_MEMBER_REMOVE': ('scurrypy.events.guild_events', 'GuildMemberRemoveEvent'),
 
         'CHANNEL_CREATE': ('scurrypy.events.channel_events', 'GuildChannelCreateEvent'),
         'CHANNEL_UPDATE': ('scurrypy.events.channel_events', 'GuildChannelUpdateEvent'),
@@ -90,6 +92,7 @@ class EventDispatcher:
         
         handler = self._handlers.get(event_name, None)
         if handler:
+            print(data)
             obj = cls.from_dict(data, self._http)
             obj.config = self.config
             await handler(self.bot, obj)

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/dispatch/prefix_dispatcher.py

@@ -1,4 +1,4 @@
-from ..client_like import ClientLike
+from ..core.client_like import ClientLike
 
 from ..events.message_events import MessageCreateEvent
 

scurrypy-0.7.2/scurrypy/events/__init__.py

@@ -0,0 +1,62 @@
+# scurrypy/events
+
+from .channel_events import (
+    # GuildChannelEvent,
+    GuildChannelCreateEvent,
+    GuildChannelUpdateEvent,
+    GuildChannelDeleteEvent,
+    ChannelPinsUpdateEvent,
+)
+
+# from .gateway_events import (
+#     SessionStartLimit,
+#     GatewayEvent
+# )
+
+from .guild_events import (
+    # GuildEvent,
+    GuildCreateEvent,
+    GuildUpdateEvent,
+    GuildDeleteEvent,
+
+    GuildMemberAddEvent,
+    GuildMemberRemoveEvent
+)
+
+# from .hello_event import HelloEvent
+
+from .interaction_events import (
+    # ApplicationCommandOptionData,
+    # ApplicationCommandData,
+    # MessageComponentData,
+    # ModalComponentData,
+    # ModalComponent,
+    # ModalData,
+    InteractionEvent
+)
+
+from .message_events import (
+    MessageCreateEvent,
+    MessageUpdateEvent,
+    MessageDeleteEvent,
+)
+
+from .reaction_events import (
+    ReactionType,
+    ReactionAddEvent,
+    ReactionRemoveEvent,
+    ReactionRemoveEmojiEvent,
+    ReactionRemoveAllEvent,
+)
+
+from .ready_event import ReadyEvent
+
+__all__ = [
+    "GuildChannelCreateEvent", "GuildChannelUpdateEvent", "GuildChannelDeleteEvent", "ChannelPinsUpdateEvent",
+    "GuildCreateEvent", "GuildUpdateEvent", "GuildDeleteEvent",
+    "GuildMemberAddEvent", "GuildMemberRemoveEvent",
+    "InteractionEvent",
+    "MessageCreateEvent", "MessageUpdateEvent", "MessageDeleteEvent",
+    "ReactionType", "ReactionAddEvent", "ReactionRemoveEvent", "ReactionRemoveEmojiEvent", "ReactionRemoveAllEvent",
+    "ReadyEvent"
+]

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/channel_events.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from ..model import DataModel
+from ..core.model import DataModel
 from typing import Optional
 
 @dataclass

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/gateway_events.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from ..model import DataModel
+from ..core.model import DataModel
 
 @dataclass
 class SessionStartLimit(DataModel):

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/guild_events.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from ..model import DataModel
+from ..core.model import DataModel
 
 from ..models import MemberModel
 from ..resources.channel import Channel
@@ -34,3 +34,23 @@ class GuildUpdateEvent(GuildEvent):
 class GuildDeleteEvent(GuildEvent):
     """Received when the bot has left a guild or the guild was deleted."""
     pass
+
+from ..models.user import MemberModel, UserModel
+
+@dataclass
+class GuildMemberAddEvent(MemberModel):
+    """Received when a member joins a guild the bot is in."""
+
+    guild_id: int
+    """ID of the guild."""
+
+
+@dataclass
+class GuildMemberRemoveEvent(DataModel):
+    """Received when a member leaves or is kicked/banned from a guild the bot is in."""
+
+    guild_id: int
+    """ID of the guild."""
+
+    user: UserModel
+    """User object of the user leaving the guild."""

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/hello_event.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from ..model import DataModel
+from ..core.model import DataModel
 
 @dataclass
 class HelloEvent(DataModel):

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/interaction_events.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 from typing import Optional
-from ..model import DataModel
+from ..core.model import DataModel
 
 from ..resources.interaction import Interaction
 from ..parts.components import ComponentTypes

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/message_events.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from ..core.model import DataModel
 
 from ..resources.message import Message
 from ..models import MemberModel

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/reaction_events.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from ..core.model import DataModel
 
 from ..models import MemberModel, EmojiModel
 

{scurrypy-0.6.5 → scurrypy-0.7.2}/scurrypy/events/ready_event.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from ..model import DataModel
+from ..core.model import DataModel
 
 from ..models import UserModel, ReadyGuildModel, ApplicationModel
 

scurrypy-0.7.2/scurrypy/models/__init__.py

@@ -0,0 +1,15 @@
+# scurrypy/models
+
+from .emoji import EmojiModel
+from .guild import ReadyGuildModel, GuildModel
+from .interaction import InteractionCallbackDataModel, InteractionCallbackModel
+from .role import RoleColors, RoleModel
+from .user import UserModel, MemberModel, ApplicationModel, IntegrationModel
+
+__all__ = [
+    "EmojiModel",
+    "ReadyGuildModel", "GuildModel",
+    "InteractionCallbackDataModel", "InteractionCallbackModel",
+    "RoleColors", "RoleModel",
+    "UserModel", "MemberModel", "ApplicationModel", "IntegrationModel"
+]