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)
  • COMMANDLESS_DISABLE_CONFIG_CACHE - optional (false by default)
  • COMMANDLESS_DEBUG - optional verbose logs (false by default)

Included components

  • RelayClient
    • send_event(event) -> Decision dict or None
    • register_bot(...) -> botId (optional flow)
    • heartbeat() (optional flow)
  • ConfigCache
    • fetches /v1/relay/config
    • local filtering for channel/user/role/premium/rate limits
    • polls every 30 seconds
  • use_discord_adapter(client, relay, mention_required=True, execute=None)
    • binds an on_message listener
    • sends events to relay
    • executes reply actions by default
    • applies local config filtering by default (disable via COMMANDLESS_DISABLE_CONFIG_CACHE=true)
    • 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.10.tar.gz (11.1 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.10-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commandless_relay-0.1.10.tar.gz
  • Upload date:
  • Size: 11.1 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.10.tar.gz
Algorithm Hash digest
SHA256 114e3a0e1d17f6dbc2a68578637ae1d15d9bef08ab523eff35d5027976eed030
MD5 a0510cba29035ffe905a73bbb02b1113
BLAKE2b-256 d003a310d052eeb541b960126f80a303697ac5e4e9cc890eb4e5240bc5b27d55

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commandless_relay-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a3e742449313dc298a5b954c88acd76fff87dfd535a1ce0ce0be2931357f4e2a
MD5 12ac86aff30cda13519cfec49b385199
BLAKE2b-256 940a954abf0f112f88267ce7220b361a5a0a4de780c4265eb6adaf2b63f95ec4

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