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.0.tar.gz (63.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.0-py3-none-any.whl (67.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yourbot_sdk-0.6.0.tar.gz
  • Upload date:
  • Size: 63.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.0.tar.gz
Algorithm Hash digest
SHA256 18c8c1b09776ae8475f83d7811c31c0bdec53c98ad00d1e1ab01408602cebf36
MD5 0bc6fb8f60df82a56a385e5919e3efde
BLAKE2b-256 d4bee3fbb5d36d5237d9c15fb2107a5f054378d3e081baadebdb013f04d0c6a1

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: yourbot_sdk-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 67.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 448d1ad8f99005a46a1ae6171ae53e7237eab587db04f6287024b6d7ca4ca194
MD5 19cc911ec1876a103191a24d7f10f81a
BLAKE2b-256 171ea8d4f71f3c24ed5083e9c6c85f46a650be6da6b38fab506f877187f225b7

See more details on using hashes here.

Provenance

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