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.3.tar.gz (80.1 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.3-py3-none-any.whl (83.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yourbot_sdk-0.8.3.tar.gz
  • Upload date:
  • Size: 80.1 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.3.tar.gz
Algorithm Hash digest
SHA256 b55a59f1a9c0ebc382576aee35ad74782a26a5aef6052692de9203831f8a86e8
MD5 671852da47df4fe0222354849d1df999
BLAKE2b-256 586f2ae1051d6e7f9b35da096f2836ea48a77179d574b6e876d39e35ed304be4

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: yourbot_sdk-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 83.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e164faab748c7d458d0968ea6d6d072e4d803c8b0f9a0d9671a4cb09301bb72e
MD5 5aed2995a4fa37ca2f47342b4ad220b9
BLAKE2b-256 8cdb83db38626d5e51cca1f64ba918c1ddaa57544cff042f465b9bc343b58450

See more details on using hashes here.

Provenance

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