nerimity-sdk-contrib 0.1.0__tar.gz

nerimity_sdk_contrib-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+*.pyo
+.env
+dist/
+build/
+*.egg-info/
+site/
+.pytest_cache/

nerimity_sdk_contrib-0.1.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: nerimity-sdk-contrib
+Version: 0.1.0
+Summary: Ready-made plugins for nerimity-sdk bots
+License: MIT
+Keywords: bot,nerimity,plugins,sdk
+Requires-Python: >=3.10
+Requires-Dist: nerimity-sdk>=0.2.5
+Description-Content-Type: text/markdown
+
+# nerimity-sdk-contrib
+
+Ready-made plugins for [nerimity-sdk](https://pypi.org/project/nerimity-sdk/) bots.
+
+```bash
+pip install nerimity-sdk-contrib
+```
+
+## Plugins
+
+| Plugin | Description |
+|---|---|
+| `WelcomePlugin` | Greets new members with a configurable message |
+| `AutoModPlugin` | Deletes messages matching a word/regex list |
+| `StarboardPlugin` | Reposts highly-reacted messages to a starboard channel |
+| `LoggingPlugin` | Logs joins, leaves, deletes, and edits to a channel |
+
+## Usage
+
+```python
+from nerimity_sdk_contrib import WelcomePlugin, AutoModPlugin, StarboardPlugin, LoggingPlugin
+
+await bot.plugins.load(WelcomePlugin(channel_id="123"))
+await bot.plugins.load(AutoModPlugin(blocked=["badword"], log_channel_id="456"))
+await bot.plugins.load(StarboardPlugin(channel_id="789", threshold=3))
+await bot.plugins.load(LoggingPlugin(channel_id="000"))
+```
+
+## Adding a new plugin
+
+1. Create `nerimity_sdk_contrib/your_plugin.py` with a class inheriting `PluginBase`
+2. Import and re-export it in `__init__.py`
+3. Add it to the table above and to the [plugin marketplace docs](https://joddabodscripts.github.io/Nerimity-SDK/plugins/)

nerimity_sdk_contrib-0.1.0/README.md

@@ -0,0 +1,33 @@
+# nerimity-sdk-contrib
+
+Ready-made plugins for [nerimity-sdk](https://pypi.org/project/nerimity-sdk/) bots.
+
+```bash
+pip install nerimity-sdk-contrib
+```
+
+## Plugins
+
+| Plugin | Description |
+|---|---|
+| `WelcomePlugin` | Greets new members with a configurable message |
+| `AutoModPlugin` | Deletes messages matching a word/regex list |
+| `StarboardPlugin` | Reposts highly-reacted messages to a starboard channel |
+| `LoggingPlugin` | Logs joins, leaves, deletes, and edits to a channel |
+
+## Usage
+
+```python
+from nerimity_sdk_contrib import WelcomePlugin, AutoModPlugin, StarboardPlugin, LoggingPlugin
+
+await bot.plugins.load(WelcomePlugin(channel_id="123"))
+await bot.plugins.load(AutoModPlugin(blocked=["badword"], log_channel_id="456"))
+await bot.plugins.load(StarboardPlugin(channel_id="789", threshold=3))
+await bot.plugins.load(LoggingPlugin(channel_id="000"))
+```
+
+## Adding a new plugin
+
+1. Create `nerimity_sdk_contrib/your_plugin.py` with a class inheriting `PluginBase`
+2. Import and re-export it in `__init__.py`
+3. Add it to the table above and to the [plugin marketplace docs](https://joddabodscripts.github.io/Nerimity-SDK/plugins/)

nerimity_sdk_contrib-0.1.0/__init__.py

@@ -0,0 +1,35 @@
+"""
+nerimity-sdk-contrib
+====================
+Ready-made plugins for nerimity-sdk bots.
+
+Usage::
+
+    pip install nerimity-sdk-contrib
+
+    from nerimity_sdk_contrib import WelcomePlugin, AutoModPlugin, StarboardPlugin, LoggingPlugin
+
+    await bot.plugins.load(WelcomePlugin(channel_id="123"))
+    await bot.plugins.load(AutoModPlugin(blocked=["badword"]))
+    await bot.plugins.load(StarboardPlugin(channel_id="456", threshold=3))
+    await bot.plugins.load(LoggingPlugin(channel_id="789"))
+
+Adding a new plugin
+-------------------
+1. Create nerimity_sdk_contrib/your_plugin.py with a class inheriting PluginBase
+2. Import and re-export it here
+3. Add it to the docs/plugins.md marketplace table
+"""
+from nerimity_sdk_contrib.welcome import WelcomePlugin
+from nerimity_sdk_contrib.automod import AutoModPlugin
+from nerimity_sdk_contrib.starboard import StarboardPlugin
+from nerimity_sdk_contrib.server_logging import LoggingPlugin
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "WelcomePlugin",
+    "AutoModPlugin",
+    "StarboardPlugin",
+    "LoggingPlugin",
+]

nerimity_sdk_contrib-0.1.0/automod.py

@@ -0,0 +1,37 @@
+import re
+from nerimity_sdk.plugins.manager import PluginBase, listener
+from nerimity_sdk.utils.mentions import mention
+
+
+class AutoModPlugin(PluginBase):
+    """Deletes messages containing blocked words or regex patterns.
+
+    Usage::
+
+        await bot.plugins.load(AutoModPlugin(
+            blocked=["badword", r"\\bspam+\\b"],
+            log_channel_id="123",   # optional
+        ))
+    """
+    name = "automod"
+
+    def __init__(self, blocked: list[str],
+                 log_channel_id: str | None = None) -> None:
+        super().__init__()
+        self._pattern = re.compile("|".join(blocked), re.IGNORECASE)
+        self.log_channel_id = log_channel_id
+
+    @listener("message:created")
+    async def on_message(self, event) -> None:
+        from nerimity_sdk.events.payloads import MessageCreatedEvent
+        if not isinstance(event, MessageCreatedEvent):
+            return
+        msg = event.message
+        if not self._pattern.search(msg.content or ""):
+            return
+        await self.bot.rest.delete_message(msg.channel_id, msg.id)
+        if self.log_channel_id:
+            await self.bot.rest.create_message(
+                self.log_channel_id,
+                f"🚫 Deleted message from {mention(msg.created_by.id)}: ||{msg.content}||"
+            )

nerimity_sdk_contrib-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "nerimity-sdk-contrib"
+version = "0.1.0"
+description = "Ready-made plugins for nerimity-sdk bots"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+keywords = ["nerimity", "bot", "sdk", "plugins"]
+dependencies = ["nerimity-sdk>=0.2.5"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["nerimity_sdk_contrib"]

nerimity_sdk_contrib-0.1.0/server_logging.py

@@ -0,0 +1,46 @@
+from nerimity_sdk.plugins.manager import PluginBase, listener
+from nerimity_sdk.utils.mentions import mention
+
+
+class LoggingPlugin(PluginBase):
+    """Logs server events to a channel: joins, leaves, deletes, edits.
+
+    Usage::
+
+        await bot.plugins.load(LoggingPlugin(channel_id="123"))
+    """
+    name = "logging"
+
+    def __init__(self, channel_id: str) -> None:
+        super().__init__()
+        self.channel_id = channel_id
+
+    async def _log(self, text: str) -> None:
+        await self.bot.rest.create_message(self.channel_id, text)
+
+    @listener("server:member_joined")
+    async def on_join(self, event) -> None:
+        from nerimity_sdk.events.payloads import MemberJoinedEvent
+        if isinstance(event, MemberJoinedEvent):
+            await self._log(f"➡️ {mention(event.member.user.id)} joined")
+
+    @listener("server:member_left")
+    async def on_leave(self, event) -> None:
+        from nerimity_sdk.events.payloads import MemberLeftEvent
+        if isinstance(event, MemberLeftEvent):
+            await self._log(f"⬅️ <user {event.user_id}> left")
+
+    @listener("message:deleted")
+    async def on_delete(self, event) -> None:
+        from nerimity_sdk.events.payloads import MessageDeletedEvent
+        if isinstance(event, MessageDeletedEvent):
+            msg = self.bot.cache.messages.get(event.message_id)
+            content = f"||{msg.content}||" if msg else f"(id: {event.message_id})"
+            await self._log(f"🗑️ Message deleted in <#{event.channel_id}>: {content}")
+
+    @listener("message:updated")
+    async def on_edit(self, event) -> None:
+        from nerimity_sdk.events.payloads import MessageUpdatedEvent
+        if isinstance(event, MessageUpdatedEvent):
+            new = event.updated.get("content", "")
+            await self._log(f"✏️ Message edited in <#{event.channel_id}>: {new}")

nerimity_sdk_contrib-0.1.0/starboard.py

@@ -0,0 +1,42 @@
+from nerimity_sdk.plugins.manager import PluginBase, listener
+from nerimity_sdk.utils.mentions import mention
+
+
+class StarboardPlugin(PluginBase):
+    """Reposts highly-reacted messages to a starboard channel.
+
+    Usage::
+
+        await bot.plugins.load(StarboardPlugin(
+            channel_id="123",
+            emoji="⭐",
+            threshold=3,
+        ))
+    """
+    name = "starboard"
+
+    def __init__(self, channel_id: str, emoji: str = "⭐",
+                 threshold: int = 3) -> None:
+        super().__init__()
+        self.channel_id = channel_id
+        self.emoji = emoji
+        self.threshold = threshold
+        self._posted: set[str] = set()
+
+    @listener("message:reaction_added")
+    async def on_reaction(self, event) -> None:
+        from nerimity_sdk.events.payloads import ReactionAddedEvent
+        if not isinstance(event, ReactionAddedEvent):
+            return
+        if event.name != self.emoji or event.count < self.threshold:
+            return
+        if event.message_id in self._posted:
+            return
+        self._posted.add(event.message_id)
+        msg = self.bot.cache.messages.get(event.message_id)
+        content = msg.content if msg else f"(message {event.message_id})"
+        author = mention(msg.created_by.id) if msg else "unknown"
+        await self.bot.rest.create_message(
+            self.channel_id,
+            f"{self.emoji} **{event.count}** | {author}\n{content}"
+        )

nerimity_sdk_contrib-0.1.0/welcome.py

@@ -0,0 +1,35 @@
+from nerimity_sdk.plugins.manager import PluginBase, listener
+from nerimity_sdk.utils.mentions import mention
+
+
+class WelcomePlugin(PluginBase):
+    """Sends a welcome message when a member joins.
+
+    Usage::
+
+        await bot.plugins.load(WelcomePlugin(
+            channel_id="123",
+            message="👋 Welcome {mention} to the server!",
+        ))
+
+    Template variables: {mention}, {username}, {tag}
+    """
+    name = "welcome"
+
+    def __init__(self, channel_id: str,
+                 message: str = "👋 Welcome {mention}!") -> None:
+        super().__init__()
+        self.channel_id = channel_id
+        self.message_template = message
+
+    @listener("server:member_joined")
+    async def on_join(self, event) -> None:
+        from nerimity_sdk.events.payloads import MemberJoinedEvent
+        if not isinstance(event, MemberJoinedEvent):
+            return
+        user = event.member.user
+        text = (self.message_template
+                .replace("{mention}", mention(user.id))
+                .replace("{username}", user.username)
+                .replace("{tag}", user.tag))
+        await self.bot.rest.create_message(self.channel_id, text)