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.1.tar.gz (74.8 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.1-py3-none-any.whl (77.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yourbot_sdk-0.8.1.tar.gz
  • Upload date:
  • Size: 74.8 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.1.tar.gz
Algorithm Hash digest
SHA256 caa07543d328d96ee813dd2e6c57bf19a34703dce766e0054b047b36df90d413
MD5 9a87f31b6b9a2f2a014a3f4bda90a633
BLAKE2b-256 ad127698c8e5dbfc10d6c7c2358e90c4ea5ee3446467ebfc1ce6b7fdd1cb0696

See more details on using hashes here.

Provenance

The following attestation bundles were made for yourbot_sdk-0.8.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: yourbot_sdk-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 77.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4bcc2858b89ef4d3a2489597587b417ff592c07751c36f623f1cbbc047c18cce
MD5 b1cf914e71fbd6210429145b6df93d9a
BLAKE2b-256 04a0511aaed33456566473b4bb316fd373203db1f79bf4935a3518fe9138f873

See more details on using hashes here.

Provenance

The following attestation bundles were made for yourbot_sdk-0.8.1-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