TSBot 
Asynchronous Python framework to build TeamSpeak 3 Server Query bots
✅ Features
- Modern Python
asyncandawaitsyntax - Fully typed interface
- Event, command and background task systems
- Secure connection through SSH, or raw connection for local servers
- Ease of use query building
- Automatic reconnection if connection is lost
- 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
1 maintainer
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.7.3.tar.gz
(23.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
tsbot-1.7.3-py3-none-any.whl
(36.8 kB
view details)
File details
Details for the file tsbot-1.7.3.tar.gz.
File metadata
- Download URL: tsbot-1.7.3.tar.gz
- Upload date:
- Size: 23.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4fb8252e38ec9fe3850c9623d4d7db0323c712cd701b7498826c60604a9a7080
|
|
| MD5 |
9e31abf4d83d5afa9827882f567d9140
|
|
| BLAKE2b-256 |
bbff0afeccdf336d267ede07270dc152e28f3e765808149899bda030a474b7d0
|
File details
Details for the file tsbot-1.7.3-py3-none-any.whl.
File metadata
- Download URL: tsbot-1.7.3-py3-none-any.whl
- Upload date:
- Size: 36.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e9659b709ac4b7fe191ca1f6be08998a9592927b049b9610c93f5da62e816930
|
|
| MD5 |
ee3f183ca482d3daad18e50e6e4e25a0
|
|
| BLAKE2b-256 |
aa8527f3a51af09d8eec68ac5f7b4b674379b17b39a6e090a485fd9ad4e5a8c1
|
