Skip to main content

Python SDK for Commandless relay API

Project description

commandless-relay (Python)

Official Python SDK for the Commandless relay API.

This package gives Python bots a simple client and a ready-to-use discord.py adapter.

Install

Core client:

pip install commandless-relay

With discord.py adapter support:

pip install "commandless-relay[discord]"

AI-only setup (no code)

Install and run from terminal, similar to the Node SDK flow:

pip install "commandless-relay[discord]"
commandless-discord

Set these environment variables first:

  • BOT_TOKEN - your Discord bot token
  • COMMANDLESS_API_KEY - API key created in Commandless dashboard
  • COMMANDLESS_SERVICE_URL (or SERVICE_URL) - optional, defaults to Commandless backend
  • BOT_ID - optional bot ID from dashboard (recommended)
  • COMMANDLESS_HMAC_SECRET - optional HMAC secret
  • COMMANDLESS_MENTION_REQUIRED - optional (true by default)

Quickstart (discord.py in code)

import os
import discord
from commandless_relay import RelayClient, use_discord_adapter

TOKEN = os.getenv("BOT_TOKEN")
API_KEY = os.getenv("COMMANDLESS_API_KEY")
BASE_URL = os.getenv("COMMANDLESS_SERVICE_URL") or os.getenv("SERVICE_URL")  # optional

intents = discord.Intents.default()
intents.message_content = True
intents.messages = True
intents.guilds = True

client = discord.Client(intents=intents)
relay = RelayClient(api_key=API_KEY, base_url=BASE_URL)  # base_url optional

use_discord_adapter(client, relay, mention_required=True)

@client.event
async def on_ready():
    print(f"Logged in as {client.user}")

client.run(TOKEN)

Environment variables

  • BOT_TOKEN - your Discord bot token
  • COMMANDLESS_API_KEY - API key created in Commandless dashboard
  • COMMANDLESS_SERVICE_URL (or SERVICE_URL) - optional, defaults to Commandless backend
  • BOT_ID - optional fixed bot id to lock config/persona
  • COMMANDLESS_HMAC_SECRET - optional HMAC secret
  • COMMANDLESS_MENTION_REQUIRED - optional (true by default)

Included components

  • RelayClient
    • send_event(event) -> Decision dict or None
    • register_bot(...) -> botId (optional flow)
    • heartbeat() (optional flow)
  • use_discord_adapter(client, relay, mention_required=True, execute=None)
    • binds an on_message listener
    • sends events to relay
    • executes reply actions by default
    • sends a clear message on billing rejection (402 / no subscription or credits)

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

commandless_relay-0.1.4.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commandless_relay-0.1.4-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file commandless_relay-0.1.4.tar.gz.

File metadata

  • Download URL: commandless_relay-0.1.4.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for commandless_relay-0.1.4.tar.gz
Algorithm Hash digest
SHA256 0e038e5fd573d3140933c38e6949fdfa6d0b66c3f2f94e42d6813a50cf343e79
MD5 ecb24c8c4d4eae5f1478e409f810c251
BLAKE2b-256 1c1583e5a815526957755dfebefa65cac812119b4f57f7fb16bbc53eb9c125d2

See more details on using hashes here.

File details

Details for the file commandless_relay-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for commandless_relay-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 911352d08b04ccacf1bbf0b09c266e0863d2c8dd41f2f8575dbea06c647edd9d
MD5 60ed50f2b85be1583603c4d96773820d
BLAKE2b-256 5bf448690d2ee8b3c7df4e085a53a626c45008195f1cdd3cd2e1e1c99e59f449

See more details on using hashes here.

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