Skip to main content

SDK for building YourBot Marketplace plugins

Project description

YourBot SDK

SDK for building plugins for the YourBot Discord bot platform.

YourBot runs marketplace plugins in sandboxed Docker containers. This SDK is the official Python interface plugins use to receive Discord events, call the Discord API, store data, render dashboards, and emit metrics — all routed through the platform so plugins never need direct network access or credentials.

Install

pip install yourbot-sdk

Python 3.10 or newer.

Hello, plugin

from yourbot_sdk import Plugin, Context

plugin = Plugin()

@plugin.on_event("message_create")
def on_message(ctx: Context, event: dict):
    if "!ping" in event.get("content", ""):
        ctx.discord.send_message(
            channel_id=event["channel_id"],
            content="Pong!",
        )

plugin.run()  # must be the last line

Drop this in a folder named my_plugin/ as __main__.py, zip it, and upload it via the Developer Portal.

CLI

The package installs a yourbot command for scaffolding and a local dev loop:

yourbot new my_plugin     # scaffold a new plugin from the template
yourbot dev               # run your plugin locally against a mock host

Documentation

Full plugin contract, capability reference, and publishing guide:

License

MIT — see LICENSE.

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

yourbot_sdk-0.8.0.tar.gz (74.4 kB view details)

Uploaded Source

Built Distribution

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

yourbot_sdk-0.8.0-py3-none-any.whl (77.3 kB view details)

Uploaded Python 3

File details

Details for the file yourbot_sdk-0.8.0.tar.gz.

File metadata

  • Download URL: yourbot_sdk-0.8.0.tar.gz
  • Upload date:
  • Size: 74.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yourbot_sdk-0.8.0.tar.gz
Algorithm Hash digest
SHA256 913164b7c2950b638cddf37546d873077cd273452004bddc1418ca3ed773472a
MD5 cb9a7a7e9010b64003787e3f309667e0
BLAKE2b-256 d9f035a0120092fc3b691172aa215f3b19d5f934909aa4785e0fa7711bfc7729

See more details on using hashes here.

Provenance

The following attestation bundles were made for yourbot_sdk-0.8.0.tar.gz:

Publisher: publish.yml on NotUSeee/yourbot-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file yourbot_sdk-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: yourbot_sdk-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 77.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for yourbot_sdk-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f886c478d6ef9d48f4f942ab3b0afbde2d36dcf47bab34195d5205d35c8f80b
MD5 ebc4dabc920f282a185f50b41b395fef
BLAKE2b-256 90d32443b9ea77128d8ee83846a07d047fc39f86bab7f5f16d1db377318ecdff

See more details on using hashes here.

Provenance

The following attestation bundles were made for yourbot_sdk-0.8.0-py3-none-any.whl:

Publisher: publish.yml on NotUSeee/yourbot-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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