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.6.1.tar.gz (68.5 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.6.1-py3-none-any.whl (73.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yourbot_sdk-0.6.1.tar.gz
  • Upload date:
  • Size: 68.5 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.6.1.tar.gz
Algorithm Hash digest
SHA256 6dd8049dd11a8190e389de7bd0748983e7af9cbf2b39d7a58100d0be7324707e
MD5 52d879ecde634369af1a2d8ea31af330
BLAKE2b-256 82a52b661a056c6c3973aec37ca5f98cfd165a4109348a560411f336f442f4dc

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: yourbot_sdk-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 73.5 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.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 73db6cf632c2d0fc4a4d94194f34d6842f9f218124a07c1cf211664e31476c73
MD5 54a6f4f1ad337b48d7fe94067ccf337b
BLAKE2b-256 e4124aae01591bf9585581939be38ba4db7c31dcf8b3992a2f38bf0071ab83fd

See more details on using hashes here.

Provenance

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