Skip to main content

Asynchronous framework to build TeamSpeak 3 Server Query bots

Reason this release was yanked:

Race condition when sending queries

Project description

TSBot

Asynchronous framework to build TeamSpeak 3 Server Query bots

✅ Features

  • Modern Python async and await syntax
  • Secure connection through SSH
  • Ease of use query building
  • Built-in and configurable ratelimiter if no access to query_ip_allowlist.txt

✏️ Examples

from __future__ import annotations

import asyncio

from tsbot import TSBot, TSCtx, query


bot = TSBot(
    username="USERNAME",
    password="PASSWORD",
    address="ADDRESS",
)


@bot.command("hello")
async def hello_world(bot: TSBot, ctx: TSCtx):
    await bot.respond(ctx, f"Hello {ctx['invokername']}!")


@bot.on("cliententerview")
async def poke_on_enter(bot: TSBot, ctx: TSCtx):
    poke_query = query("clientpoke").params(clid=ctx["clid"], msg="Welcome to the server!")
    await bot.send(poke_query)


asyncio.run(bot.run())

Check out 📁examples for more

📦 Installation

Python 3.10 or higher is required

Installing with pip:

# Linux/macOS
python3 -m pip install tsbot

# Windows
py -3 -m pip install tsbot

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

tsbot-1.3.0.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

tsbot-1.3.0-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

Details for the file tsbot-1.3.0.tar.gz.

File metadata

  • Download URL: tsbot-1.3.0.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tsbot-1.3.0.tar.gz
Algorithm Hash digest
SHA256 44de98becdb127a5e16c5252d59d913fc6b968fdc142ff6c17bce9b2ab27079a
MD5 a18e38787f81c206aa07de35a0c56ea4
BLAKE2b-256 43691bc8563e66b253443b08e6f6a3b52d4f2fb1afbb4d4c987e68b2d74fc013

See more details on using hashes here.

File details

Details for the file tsbot-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: tsbot-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 29.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tsbot-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65be499d115f03f76f4f261a8613519cb75f1a6d4530d7b4f76681461e8bc799
MD5 85878d8880cf4b15fadf2fb94e09e69e
BLAKE2b-256 684aa54a0823381f9bc825a816c18661103632d4d3ddb3d65578fbc2b8ce116b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page