Skip to main content

Ready-made plugins for nerimity-sdk bots

Project description

nerimity-sdk-contrib

Ready-made plugins for nerimity-sdk bots.

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

from nerimity_sdk import Bot
from nerimity_sdk_contrib import WelcomePlugin, AutoModPlugin, StarboardPlugin, LoggingPlugin, RoleMenuPlugin, PollPlugin

bot = Bot(token="...", prefix="!")

@bot.on("ready")
async def on_ready(me):
    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"))

bot.run()

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nerimity_sdk_contrib-1.2.0.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nerimity_sdk_contrib-1.2.0-py3-none-any.whl (1.5 kB view details)

Uploaded Python 3

File details

Details for the file nerimity_sdk_contrib-1.2.0.tar.gz.

File metadata

  • Download URL: nerimity_sdk_contrib-1.2.0.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for nerimity_sdk_contrib-1.2.0.tar.gz
Algorithm Hash digest
SHA256 13c55c6c04053cc303d08eb2a617a74cbca41c4458b43579059b41a6f5079af5
MD5 bab008414fe1712efb4f5b183387893c
BLAKE2b-256 7493326592e6bb2831ed035d79afcb465e04072f19c92b918f2eb8d9ea9f1afa

See more details on using hashes here.

File details

Details for the file nerimity_sdk_contrib-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nerimity_sdk_contrib-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e39c191a498dcad810754ad3fe899453c127293662d5d2da53dde49fe72a48d
MD5 0fbae7fce7ce44298a5890ebd3dd077a
BLAKE2b-256 433352ae856b1fcdae7a1328f1251d877ee3f1feb6c781902b9ea880d4427cad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page