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.2.tar.gz (75.0 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.2-py3-none-any.whl (78.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yourbot_sdk-0.8.2.tar.gz
  • Upload date:
  • Size: 75.0 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.2.tar.gz
Algorithm Hash digest
SHA256 81df34f6717c718f46fa95f19e2e0f13bed6b746ed9fbba2eae5f540e4502aa9
MD5 93258ebd1ba2e2e00f6a5d15df98039f
BLAKE2b-256 04d6e29314a3fd7c5165de20876873517a3258c7b860eb5fc224e72227738d0a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: yourbot_sdk-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 78.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 26584654f05d10869840b0e7e29e9ae09539c0298e5e066b4daf96a59c824425
MD5 261b66fc98491b3a6fda3e8ed47213bb
BLAKE2b-256 5eafe993f87ad3224ceed179963aff2d539a907ba8ac0ac412fa2248d6f1a697

See more details on using hashes here.

Provenance

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