scurrypy 0.4__py3-none-any.whl → 0.6.6__py3-none-any.whl

discord/parts/embed.py

@@ -1,154 +0,0 @@
-from dataclasses import dataclass
-from typing import Optional
-from discord.model import DataModel
-from datetime import datetime, timezone
-from ..models.user import UserModel
-
-@dataclass
-class _EmbedAuthor(DataModel):
-    """Embed author parameters."""
-    name: str
-    url: Optional[str] = None
-    icon_url: Optional[str] = None
-
-@dataclass
-class _EmbedThumbnail(DataModel):
-    """Embed thumbnail."""
-    url: str
-
-@dataclass
-class _EmbedImage(DataModel):
-    """Embed image."""
-    url: str
-
-@dataclass
-class _EmbedFooter(DataModel):
-    """Embed footer."""
-    text: str
-    url: Optional[str] = None
-    icon_url: Optional[str] = None
-
-@dataclass
-class _EmbedField(DataModel):
-    """Embed field."""
-    name: str
-    value: str
-    inline: Optional[bool] = None
-
-@dataclass
-class EmbedBuilder(DataModel):
-    """Represents the Embed portion of a message."""
-
-    title: Optional[str] = None
-    """This embed's title."""
-
-    description: Optional[str] = None
-    """This embed's description."""
-
-    timestamp: Optional[str] = None
-    """Timestamp of when the embed was sent."""
-
-    color: Optional[int] = None
-    """Embed's accent color."""
-
-    author: Optional[_EmbedAuthor] = None
-    """Embed's author."""
-
-    thumbnail: Optional[_EmbedThumbnail] = None
-    """Embed's thumbnail attachment."""
-
-    image: Optional[_EmbedImage] = None
-    """Embed's image attachment."""
-
-    fields: Optional[list[_EmbedField]] = None
-    """List of embed's fields."""
-
-    footer: Optional[_EmbedFooter] = None
-    """Embed's footer."""
-
-    def set_color(self, hex: str):
-        """Set this embed's color with a hex.
-
-        Args:
-            hex (str): color as a hex code (format: #FFFFFF)
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.color=int(hex.strip('#'), 16)
-        return self
-    
-    def set_user_author(self, user: UserModel):
-        """Set this embed's author.
-
-        Args:
-            user (UserModel): the user model
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.author = _EmbedAuthor(
-            name=user.username,
-            icon_url=f"https://cdn.discordapp.com/avatars/{user.id}/{user.avatar}.png"
-        )
-        return self
-    
-    def set_image(self, url: str):
-        """Set this embed's image.
-
-        Args:
-            url (str): attachment://<file> scheme or http(s) URL
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.image = _EmbedImage(url=url)
-        return self
-    
-    def set_thumbnail(self, url: str):
-        """Set this embed's thumbnail.
-
-        Args:
-            url (str): attachment://<file> scheme or http(s) URL
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.thumbnail = _EmbedThumbnail(url=url)
-        return self
-    
-    def set_footer(self, text: str, icon_url: str = None):
-        """Set this embed's footer.
-
-        Args:
-            text (str): footer's text
-            icon_url (str, optional): attachment://<file> scheme or http(s) URL.
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.footer = _EmbedFooter(text=text, icon_url=icon_url)
-        return self
-    
-    def add_field(self, name: str, value: str, is_inline: bool = False):
-        """Add a field to this embed.
-
-        Args:
-            name (str): field's title
-            value (str): field's text
-            is_inline (bool): if this field should be inlined
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.fields.append(_EmbedField(name=name, value=value, inline=is_inline))
-        return self
-    
-    def set_timestamp(self):
-        """Set this embed's timestamp.
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.timestamp = datetime.now(timezone.utc).isoformat()
-        return self

discord/parts/message.py

@@ -1,194 +0,0 @@
-from dataclasses import dataclass, field
-from typing import Optional, TypedDict, Unpack, Literal
-from discord.model import DataModel
-from .embed import EmbedBuilder
-from .action_row import ActionRow
-from .components_v2 import Container
-
-class MessageFlags:
-    """Flags that can be applied to a message."""
-    CROSSPOSTED = 1 << 0
-    """Message has been published."""
-
-    IS_CROSSPOST = 1 << 1
-    """Message originated from another channel."""
-
-    SUPPRESS_EMBEDS = 1 << 2
-    """Hide embeds (if any)."""
-
-    EPHEMERAL = 1 << 6
-    """Only visible to the invoking user."""
-
-    LOADING = 1 << 7
-    """Thinking response."""
-
-    IS_COMPONENTS_V2 = 1 << 15
-    """This message includes Discord's V2 Components."""
-
-class MessageFlagParams(TypedDict, total=False):
-    """Parameters for setting message flags."""
-    crossposted: bool
-    is_crosspost: bool
-    suppress_embeds: bool
-    ephemeral: bool
-    loading: bool
-    is_components_v2: bool
-
-@dataclass
-class _MessageReference(DataModel):
-    message_id: int
-    channel_id: int
-    type: int = 0
-
-@dataclass
-class _Attachment(DataModel):
-    """Represents an attachment."""
-    id: int
-    path: str
-    filename: str
-    description: str
-
-    def _to_dict(self):
-        return {
-            'id': self.id,
-            'filename': self.filename,
-            'description': self.description
-        }
-
-@dataclass
-class MessageBuilder(DataModel):
-    """Describes expected params when editing/creating a message."""
-
-    content: Optional[str] = None
-    """Message text content."""
-
-    flags: Optional[int] = 0
-    """Message flags. See [`MessageFlags`][discord.parts.message.MessageFlags] for details."""
-
-    components: Optional[list[ActionRow | Container]] = field(default_factory=list)
-    """Components to be attached to this message."""
-
-    attachments: Optional[list[_Attachment]] = field(default_factory=list)
-    """Attachments to be attached to this message."""
-
-    embeds: Optional[list[EmbedBuilder]] = field(default_factory=list)
-    """Embeds to be attached to this message."""
-
-    message_reference: Optional[_MessageReference] = None
-    """Message reference if reply."""
-
-    def add_row(self, row: ActionRow):
-        """Add an action row to this message.
-
-        Args:
-            row (ActionRow): the ActionRow object
-
-        Returns:
-            (MessageBuilder): self
-        """
-        self.components.append(row)
-        return self
-    
-    def add_container(self, container: Container, *, has_container_boarder: bool = False):
-        """Add a container to this message.
-
-        Args:
-            container (Container): the Container object.
-            has_container_boarder (bool, optional): If message should be contained in an Embed-like container. Defaults to False.
-
-        Returns:
-            (MessageBuilder): self
-        """
-        if has_container_boarder:
-            self.components.append(container)
-        else:
-            self.components.extend(container.components)
-        return self
-    
-    def add_embed(self, embed: EmbedBuilder):
-        """Add an embed to this message.
-
-        Args:
-            embed (EmbedBuilder): The EmbedBuilder object.
-
-        Returns:
-            (MessageBuilder): self
-        """
-        self.embeds.append(embed)
-        return self
-
-    def add_attachment(self, file_path: str, description: str = None):
-        """Add an attachment to this message
-
-        Args:
-            file_path (str): full qualifying path to file
-            description (str, optional): file descriptor. Defaults to None.
-
-        Returns:
-            (MessageBuilder): self
-        """
-        import os
-        
-        self.attachments.append(
-            _Attachment(
-                id=len(self.attachments), 
-                filename=os.path.basename(file_path), 
-                path=file_path,
-                description=description
-            )
-        )
-        return self
-    
-    def set_flags(self, **flags: Unpack[MessageFlagParams]):
-        """Set this message's flags using MessageFlagParams.
-
-        Args:
-            flags (Unpack[MessageFlagParams]): message flags to set. (set respective flag to True to toggle.)
-
-        Raises:
-            (ValueError): invalid flag
-
-        Returns:
-            (MessageBuilder): self
-        """
-        _flag_map = {
-            'crossposted': MessageFlags.CROSSPOSTED,
-            'is_crosspost': MessageFlags.IS_CROSSPOST,
-            'suppress_embeds': MessageFlags.SUPPRESS_EMBEDS,
-            'ephemeral': MessageFlags.EPHEMERAL,
-            'loading': MessageFlags.LOADING,
-            'is_components_v2': MessageFlags.IS_COMPONENTS_V2,
-        }
-
-        # each flag maps to a specific combined bit!
-        for name, value in flags.items():
-            if name not in _flag_map:
-                raise ValueError(f"Invalid flag: {name}")
-            if value:
-                self.flags |= _flag_map[name]
-                
-        return self
-
-    def _set_reference(self, 
-        message_id: int, 
-        channel_id: int,
-        ref_type: Literal['Default', 'Forward'] = 'Default'
-    ):
-        """Internal helper for setting this message's reference message. Used in replies.
-
-        Args:
-            message_id (int): message to reference
-
-        Returns:
-            (MessageBuilder): self
-        """
-        _ref_types = {
-            'DEFAULT': 0,
-            'FORWARD': 1
-        }
-        self.message_reference = _MessageReference(
-            type=_ref_types.get(ref_type.upper()), 
-            channel_id=channel_id,
-            message_id=message_id
-        )
-        return self

discord/parts/modal.py

@@ -1,21 +0,0 @@
-from dataclasses import dataclass, field
-from discord.model import DataModel
-from .components_v2 import Label
-
-@dataclass
-class ModalBuilder(DataModel):
-    title: str
-    custom_id: str = None
-    components: list[Label] = field(default_factory=list)
-
-    def add_label(self, component: Label):
-        """Add a label component to this modal.
-
-        Args:
-            component (Label): the label component
-
-        Returns:
-            ModalBuilder: self
-        """
-        self.components.append(component)
-        return self

scurrypy-0.4.dist-info/METADATA

@@ -1,130 +0,0 @@
-Metadata-Version: 2.4
-Name: scurrypy
-Version: 0.4
-Summary: Dataclass-driven 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)
-
-> **Official Repository**  
-> This is the original and official repository of **ScurryPy**, maintained by [Furmissile](https://github.com/Furmissile).  
-> Forks and community extensions are welcome under the project’s license and attribution guidelines.
-
-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
-* 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.*
-
-```py
-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_ids=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.
-```py
-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()
-```
-
-## Contribution and Fork Policy
-ScurryPy follows a simple philosophy: **clarity, simplicity, and direct interaction with the Discord API**.
-It favors explicit, dataclass-driven design over heavy abstraction — and contributions should stay true to that style.
-
-This is a community-supported project guided by the design and principles of **Furmissile**.
-You are welcome to explore, modify, and extend the codebase under the terms of its license — but please follow these guidelines to ensure proper attribution and clarity.
-
-### You May
-* Fork this repository for personal or collaborative development.
-* Submit pull requests for bug fixes or new features that align with ScurryPy’s goals.
-* Reuse parts of the code in your own projects, provided attribution is preserved.
-
-### You May NOT
-* Remove or alter existing copyright notices or attributions.
-* Present a fork as the official ScurryPy project.
-* Use the name “ScurryPy” or its documentation to promote a fork without permission.
-
-If you plan to make substantial changes or release your own variant:
-* Rename the fork to avoid confusion (e.g., `scurrypy-plus` or `scurrypy-extended`).
-* Add a note in your README acknowledging the original project:
-> "This project is a fork of [ScurryPy](https://github.com/Furmissile/scurrypy)
- by Furmissile."
-
- ## License
- This project is licensed under the Furmissile License, which allows viewing, modification, and redistribution with proper attribution.
-
-See the [License](./LICENSE) for details.
-
-## Like What You See?
-Check out the full [documentation](https://furmissile.github.io/scurrypy)
- for more examples, guides, and API reference!

scurrypy-0.4.dist-info/RECORD

@@ -1,54 +0,0 @@
-discord/__init__.py,sha256=cETkxHmm0s9YkSJgn-1daQhnbL96fuD7L9SIg2t5vBg,6823
-discord/client.py,sha256=9DcgF8Tb-K7t781GILBIh4LcU_Q1aYrNW_mHU-TA0bw,14144
-discord/client_like.py,sha256=JyJq0XBq0vKuPBJ_ZnYf5yAAuX1zz_2B1TZBQE-BYbQ,473
-discord/config.py,sha256=OH1A2mNKhDlGvQYASEsVUx2pNxP1YQ2a7a7z-IM5xFg,200
-discord/error.py,sha256=AlislRTna554cM6KC0KrwKugzYDYtx_9C8_3QFe4XDc,2070
-discord/gateway.py,sha256=1TVUKrd3JovoM4df5-GlMZ0kz15Xls5V48ShXDSlK3Q,5334
-discord/http.py,sha256=BI7bCjedh8zuu5pdOLhI-XwMZfdVj5qP9ZZY6WJqtgo,10511
-discord/intents.py,sha256=Lf2fogFFDqilZeKJv7tcUgKmMW3D7ykK4bBNi-zDzYA,2866
-discord/logger.py,sha256=qAmOc3geCcCCqPhdi61SVWzMDewmM8Q_KWhTcjO46j8,4726
-discord/model.py,sha256=CmuxyoWLWokE_UvCQ9M7U9Cr7JH9R7ULMv9KMwzXjDQ,3105
-discord/dispatch/__init__.py,sha256=m7ixrbNhOV9QRORXPw6LSwxofQMAvLmPFBweBZu9ACc,20
-discord/dispatch/command_dispatcher.py,sha256=pyJOQaZLZYrHUEs6HEWp8XMKTMZX4SBrwTizGKIeUG8,5904
-discord/dispatch/event_dispatcher.py,sha256=1A7Qof_IzTi5_14IMPxIQDpvo3-Sj-X0KZWOuVGH53k,3764
-discord/dispatch/prefix_dispatcher.py,sha256=4mkn3cuXTjdEChbewkbZQqd_sMKm4jePSFKKOPbt12g,2065
-discord/events/__init__.py,sha256=xE8YtJ7NKZkm7MLnohDQIbezh3ColmLR-3BMiZabt3k,18
-discord/events/channel_events.py,sha256=t9UL4JjDqulAP_XepQ8MRMW54pNRqCbIK3M8tauzf9I,1556
-discord/events/guild_events.py,sha256=Ok9tW3tjcwtbiqJgbe-42d9-R3-2RzqmIgBHEP-2Pcc,896
-discord/events/hello_event.py,sha256=O8Ketu_N943cnGaFkGsAHfWhgKXFQCYCqSD3EqdsXjA,225
-discord/events/interaction_events.py,sha256=p5jb_KXrbE84773flwvbbS6yeh4f1w5Z-y93nQZJbEk,4374
-discord/events/message_events.py,sha256=M5xdaJH1zRzdZk0oN0Jykaeu9k09EjgZjeiIT_EkL1A,1475
-discord/events/reaction_events.py,sha256=xx7GD-fqakhJmS-X-HbuAUg9pg6Gqo_KRtLTdPJu7UE,2643
-discord/events/ready_event.py,sha256=c3Pf4ndNYV2byuliADi8pUxpuvKXa9FLKNz_uzIWGso,794
-discord/models/__init__.py,sha256=ZKhFO5eX4GbTRdvi4CU4z2hO-HQU29WZw2x4DujvARY,18
-discord/models/application.py,sha256=2sXtRysUc2TJ40FjdcrWgosmwMrp_h3ybddubQMixKM,924
-discord/models/emoji.py,sha256=6iz1DhWj_eTUj2KHmwMewjB3AdEBm68EmIZp2WFFCQg,932
-discord/models/guild.py,sha256=aXUByOUUIGt9d2qIGC6_X_vh0Nyib8Iqj5ZElBeNV_I,819
-discord/models/integration.py,sha256=V29RO2925mQbVXPAMt665cML3m8mJACYmdJLWwbbUyE,612
-discord/models/interaction.py,sha256=VPbf49C1RmQpDSODk3e1voW8EnbVsH_w1qpmiq4hVRM,700
-discord/models/member.py,sha256=pkI-NVRMb3hUBkxI26FSYZxzx2mRNGXOeWWCw3BGGsY,705
-discord/models/role.py,sha256=erlERmK-IZz4YzSNY-XLNvCc-Z5PoVlClxPOX67dQJg,1169
-discord/models/user.py,sha256=lgG6GoU_7L68oHt6PGTzTkU1vrbsclRQzGjKzsLBeKA,298
-discord/parts/__init__.py,sha256=yROb-BqEw-FKXqq_-0WbP33U-Arm_9NpJuEamXpvjeA,19
-discord/parts/action_row.py,sha256=QVi5-ZtVRBKbG0n0L53cj4bu2ZEMUnJ9y3TlqFxaHlg,7105
-discord/parts/channel.py,sha256=2wmEjmRqUpORzL3CFp2rugMxrpSm_LxxvlcrmWIH4r4,584
-discord/parts/command.py,sha256=CPyPO_T5ULp7j7syF9z2LztP3SF6KyX89sodz2c40Aw,2924
-discord/parts/component_types.py,sha256=qr1R0jzXpE_h9Xv4P5DyYRSuhxS0Qnm9aag-JKrJvBA,131
-discord/parts/components_v2.py,sha256=R2ihx8st12oHUFxJ-H_-qPR-4aSlSPslNfKOCBNiwTw,11403
-discord/parts/embed.py,sha256=_PV-lEAKn-MiXyyLa2s8JKHEplA8J9dDO80NPdZtmLk,3986
-discord/parts/message.py,sha256=xfzVuDafx9kXsY4Mfk3urMj1HbJXTEVdHvyTZKRwCt0,5800
-discord/parts/modal.py,sha256=EX6J9Mh5dAQBOZqYKzSE7SFsKLfM_B1BhcJamjBNkZw,554
-discord/parts/role.py,sha256=cK96UdgT-kU0gY5C_1LZXPrYg144x2RDmGjT28so57A,920
-discord/resources/__init__.py,sha256=EdzYKftSLqqr3Bpzc0_90kfozJXOtp9jNTIHhCTt_-0,21
-discord/resources/application.py,sha256=vYMTli_FSbC7venMepsJ9bkzdEQVkKYpnxCJ9K2XDho,2765
-discord/resources/bot_emojis.py,sha256=RvGCSOBkjS39P2aab0FzYUOTzBOiHX99RLrJZzAYNiU,1701
-discord/resources/channel.py,sha256=fe2JUp943VnXa-BKyRMtNP-JyNd_Mp516sWBKHKn_GI,6915
-discord/resources/guild.py,sha256=Unld1lWY3XynmRHU2FCi3-LA9VNp2thMI2BlILUTTxk,8183
-discord/resources/interaction.py,sha256=esbkN8r7c1GhAvRqldrua_a6PSuIVPJLw3OQAZ0zy1c,5922
-discord/resources/message.py,sha256=RtvcCRx0lwW-mHPl3aNYoEvGffrvtpLsQ2fVWckywVI,7527
-discord/resources/user.py,sha256=vk89TnCVi-6ZgbDs_TZTCXrx_NfFS5Q9Wi_itYoaoyg,3085
-scurrypy-0.4.dist-info/licenses/LICENSE,sha256=qIlBETYpSEU8glbiwiJbuDxVl-2WIuf1PDqJemMjKkc,792
-scurrypy-0.4.dist-info/METADATA,sha256=J9enmBVZsPDNbClN0t9p5_SAksFXso23AIjtgBREbNE,4795
-scurrypy-0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scurrypy-0.4.dist-info/top_level.txt,sha256=fJkrNbR-_8ubMBUcDEJBcfkpECrvSEmMrNKgvLlQFoM,8
-scurrypy-0.4.dist-info/RECORD,,

scurrypy-0.4.dist-info/top_level.txt

@@ -1 +0,0 @@
-discord