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.7.1.tar.gz (69.7 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.7.1-py3-none-any.whl (74.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yourbot_sdk-0.7.1.tar.gz
  • Upload date:
  • Size: 69.7 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.7.1.tar.gz
Algorithm Hash digest
SHA256 7e9cde494cabebefb675d6225a7f9f93ece2d0134ca96443d0c61589ab3d7ce8
MD5 79fa4ef61e1aabceaa6f31ea230adc96
BLAKE2b-256 4ad62c82d9660237bb8e0a0223c6db13c209434f363562cf81b2e61195fe03a9

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: yourbot_sdk-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 74.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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 decbf995c0e58427fc050622b0bfb42ea27028fc8caae4db2674c3feba8644f4
MD5 b9b1d3fa2ccf9fa1ed2262f9d9563caa
BLAKE2b-256 114e387b2d214803a7ee769514c1b6789961e56ee82dbbee7a7a15f5cb29138b

See more details on using hashes here.

Provenance

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