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.4.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.4-py3-none-any.whl
(36.9 kB
view details)
File details
Details for the file tsbot-1.7.4.tar.gz.
File metadata
- Download URL: tsbot-1.7.4.tar.gz
- Upload date:
- Size: 23.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","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 |
6e613b3a322cc659a5dd4740b530127c243e98549780f7375357cf285b02e896
|
|
| MD5 |
51825fd624de9e9dc2ae7bad1a05474f
|
|
| BLAKE2b-256 |
447d5cae6d2e59b4ceacd59e7338343cad1919fe4801d5d371afccef6acc3884
|
File details
Details for the file tsbot-1.7.4-py3-none-any.whl.
File metadata
- Download URL: tsbot-1.7.4-py3-none-any.whl
- Upload date:
- Size: 36.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","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 |
680d859ca513d2b656d1ef41b46149c202623c458b5c38944358d07b865d817d
|
|
| MD5 |
41173fe44804d3eddd61198abc936bbd
|
|
| BLAKE2b-256 |
6e73655bce7f0b0012854e3a509e4495b95439e1dec4a42d6b2145abb1e1cadc
|
