pyyapper 1.0.0__py3-none-any.whl

pyyapper/models.py

@@ -0,0 +1,206 @@
+"""Lightweight data models returned by PyYapper.
+
+These are plain dataclasses built from the JSON the API returns. Unknown fields
+are kept in ``raw`` so nothing is ever lost, and every model supports attribute
+access (``msg.content``) as well as dict-style access (``msg["content"]``).
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any, Optional
+
+
+class _Model:
+    """Mixin providing dict-like access and a ``raw`` payload."""
+
+    raw: dict[str, Any] = field(default_factory=dict) if False else {}  # placeholder
+
+    def __getitem__(self, key: str) -> Any:
+        if hasattr(self, key):
+            return getattr(self, key)
+        return self.raw.get(key)
+
+    def get(self, key: str, default: Any = None) -> Any:
+        try:
+            v = self[key]
+        except (KeyError, AttributeError):
+            v = None
+        return default if v is None and key not in (self.__dict__) else v
+
+    def to_dict(self) -> dict[str, Any]:
+        out = dict(self.raw)
+        for k, v in self.__dict__.items():
+            if k == "raw":
+                continue
+            if isinstance(v, _Model):
+                out[k] = v.to_dict()
+            elif isinstance(v, list):
+                out[k] = [x.to_dict() if isinstance(x, _Model) else x for x in v]
+            else:
+                # map snake/camel? keep as is
+                out[k] = v
+        return out
+
+
+@dataclass
+class User(_Model):
+    id: str = ""
+    username: str = ""
+    display_name: Optional[str] = None
+    bio: str = ""
+    avatar_url: Optional[str] = None
+    banner_url: Optional[str] = None
+    created_at: Optional[str] = None
+    bot: Optional[dict[str, Any]] = None
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "User":
+        data = data or {}
+        return cls(
+            id=data.get("id", "") or "",
+            username=data.get("username", "") or "",
+            display_name=data.get("display_name"),
+            bio=data.get("bio", "") or "",
+            avatar_url=data.get("avatar_url"),
+            banner_url=data.get("banner_url"),
+            created_at=data.get("created_at"),
+            bot=data.get("bot"),
+            raw=dict(data),
+        )
+
+
+@dataclass
+class Server(_Model):
+    id: str = ""
+    name: str = ""
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "Server":
+        data = data or {}
+        return cls(id=data.get("id", "") or "", name=data.get("name", "") or "", raw=dict(data))
+
+
+@dataclass
+class Category(_Model):
+    id: str = ""
+    name: str = ""
+    position: int = 0
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "Category":
+        data = data or {}
+        return cls(
+            id=data.get("id", "") or "",
+            name=data.get("name", "") or "",
+            position=data.get("position", 0) or 0,
+            raw=dict(data),
+        )
+
+
+@dataclass
+class Channel(_Model):
+    id: str = ""
+    name: str = ""
+    type: str = "text"
+    server_id: Optional[str] = None
+    position: int = 0
+    category: Optional[Category] = None
+    category_id: Optional[str] = None
+    private: bool = False
+    read_only: bool = False
+    slowmode: int = 0
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "Channel":
+        data = data or {}
+        cat = data.get("category")
+        return cls(
+            id=data.get("id", "") or "",
+            name=data.get("name", "") or "",
+            type=data.get("type", "text") or "text",
+            server_id=data.get("server_id"),
+            position=data.get("position", 0) or 0,
+            category=Category.from_dict(cat) if isinstance(cat, dict) else None,
+            category_id=data.get("category_id"),
+            private=bool(data.get("private", False)),
+            read_only=bool(data.get("read_only", False)),
+            slowmode=data.get("slowmode", 0) or 0,
+            raw=dict(data),
+        )
+
+
+@dataclass
+class Member(_Model):
+    user_id: str = ""
+    username: str = ""
+    roles: list[str] = field(default_factory=list)
+    nickname: Optional[str] = None
+    timeout: Optional[str] = None
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "Member":
+        data = data or {}
+        return cls(
+            user_id=data.get("user_id", "") or data.get("id", "") or "",
+            username=data.get("username", "") or "",
+            roles=list(data.get("roles", []) or []),
+            nickname=data.get("nickname"),
+            timeout=data.get("timeout"),
+            raw=dict(data),
+        )
+
+
+@dataclass
+class Message(_Model):
+    id: str = ""
+    channel_id: Optional[str] = None
+    channel_name: Optional[str] = None
+    server_id: Optional[str] = None
+    author_id: str = ""
+    author: Optional[str] = None
+    content: str = ""
+    attachment: Optional[str] = None
+    reply_to_id: Optional[str] = None
+    created_at: Optional[str] = None
+    mentioned: bool = False
+    command: Optional[str] = None
+    args: Optional[str] = None
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "Message":
+        data = data or {}
+        return cls(
+            id=data.get("id", "") or "",
+            channel_id=data.get("channel_id"),
+            channel_name=data.get("channel_name"),
+            server_id=data.get("server_id"),
+            author_id=data.get("author_id", "") or "",
+            author=data.get("author"),
+            content=data.get("content", "") or "",
+            attachment=data.get("attachment"),
+            reply_to_id=data.get("reply_to_id"),
+            created_at=data.get("created_at"),
+            mentioned=bool(data.get("mentioned", False)),
+            command=data.get("command"),
+            args=data.get("args"),
+            raw=dict(data),
+        )
+
+
+@dataclass
+class Role(_Model):
+    id: str = ""
+    name: str = ""
+    raw: dict[str, Any] = field(default_factory=dict, repr=False)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any] | None) -> "Role":
+        data = data or {}
+        return cls(id=data.get("id", "") or "", name=data.get("name", "") or "", raw=dict(data))

pyyapper-1.0.0.dist-info/METADATA

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: pyyapper
+Version: 1.0.0
+Summary: An intuitive, async Python library for the Yapper bot API.
+Author: PyYapper contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/pyyapper/pyyapper
+Project-URL: Documentation, https://www.yapper.website/developers/
+Project-URL: Repository, https://github.com/pyyapper/pyyapper
+Project-URL: Issues, https://github.com/pyyapper/pyyapper/issues
+Keywords: yapper,bot,api,chat,discord-like
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Dynamic: license-file
+
+# PyYapper
+
+An intuitive, async Python library for the [Yapper](https://www.yapper.website) bot API.
+Designed to feel familiar to `discord.py` users while staying small and dependency-light.
+
+## Install
+
+```bash
+pip install pyyapper
+```
+
+Requires Python 3.9+ and `aiohttp`.
+
+## Quick start
+
+```python
+from pyyapper import Bot
+
+bot = Bot("yb_...")  # your token from Settings -> Developer
+
+
+@bot.command("ping", description="Is the bot alive?")
+async def ping(ctx):
+    await ctx.reply("pong")
+
+
+@bot.event
+async def on_ready(me):
+    print("online as", me.username)
+
+
+bot.run()
+```
+
+## Features
+
+- Async-first, with a synchronous `bot.run()` entry point.
+- Decorator-based commands and events (`@bot.command`, `@bot.event`, `@bot.button`).
+- Rich message context: `ctx.reply`, `ctx.say`, `ctx.author_mention`, `ctx.argv`.
+- Button/interaction helpers: `i.reply`, `i.ephemeral`, `i.update`, `i.ack`.
+- `Embed`, `Button`, `Row` builders with chaining.
+- Typed data models (`User`, `Message`, `Channel`, ...) and a full exception hierarchy.
+- Automatic retry on `429` with `Retry-After`, exponential backoff, timeouts.
+- Long-polling event loop with cursor tracking (nothing lost on reconnect).
+
+## Error handling
+
+```python
+from pyyapper import Bot, NotFound, Forbidden, RateLimited
+
+bot = Bot("yb_...")
+
+async def main():
+    try:
+        await bot.delete("some-channel", "some-message")
+    except NotFound:
+        print("message already gone")
+    except Forbidden:
+        print("missing Manage messages permission")
+    except RateLimited as e:
+        print("slow down, retry after", e.retry_after)
+
+import asyncio
+asyncio.run(main())
+```
+
+## Documentation
+
+See the Yapper developer docs: https://www.yapper.website/developers
+
+## License
+
+MIT

pyyapper-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+pyyapper/__init__.py,sha256=U74YtGzmhK_2e5KnFMgOGHWKy1zeg3Yv5_KcEwyfui4,1138
+pyyapper/_version.py,sha256=Aj77VL1d5Mdku7sgCgKQmPuYavPpAHuZuJcy6bygQZE,21
+pyyapper/bot.py,sha256=_Sqv2Kbv9pCveP8octJ8nenvroN3hVZF4VL5NWaOKKc,30577
+pyyapper/buttons.py,sha256=d-apqYmVlCSdE8oUU9UbjukjcjNygWJpJcad96Fgkrk,3606
+pyyapper/embeds.py,sha256=uFecliX5bVaGfTnQDQTHcuU8Pa5AlIuoXvJESvirSNg,3893
+pyyapper/errors.py,sha256=bTWBfupz_6q1VZ7JyvYUC99UL-WdfI05AbJE54AOrIQ,2608
+pyyapper/http.py,sha256=smOX06Sq-Sj0X5VAQch1K08J4v4eQLdmDTAThoLeuKc,6967
+pyyapper/models.py,sha256=ciy7lgKVhItP8ByoYjB4Ccg16zWnVIpyeckmXd_sIzE,6535
+pyyapper/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyyapper-1.0.0.dist-info/licenses/LICENSE,sha256=i6ySgvPeu51QAUBPdHz8fKAr6O6LFjqiqlYj-8FOjGw,1077
+pyyapper-1.0.0.dist-info/METADATA,sha256=kXzOJWh63KeqJfcLcG6OHIGhjxV6ZADrwn8dG2nMz_Y,3256
+pyyapper-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+pyyapper-1.0.0.dist-info/top_level.txt,sha256=E2KcBKx1aqPrnt_p_T5R8uxNcPZn1vmBDoeizrjJlyo,9
+pyyapper-1.0.0.dist-info/RECORD,,

pyyapper-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyyapper-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PyYapper contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyyapper-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyyapper