Asynchronous framework to build TeamSpeak 3 Server Query bots
Project description
TSBot
Asynchronous Python framework to build TeamSpeak 3 Server Query bots
✅ Features
- Modern Python
async
andawait
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
Release history Release notifications | RSS feed
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.1.tar.gz
(26.2 kB
view details)
Built Distribution
tsbot-1.3.1-py3-none-any.whl
(30.0 kB
view details)
File details
Details for the file tsbot-1.3.1.tar.gz
.
File metadata
- Download URL: tsbot-1.3.1.tar.gz
- Upload date:
- Size: 26.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 073e9bd7c28aac3c7a4e70dea3e51bf8fbef5973c97d20834f93fcc53e4eccde |
|
MD5 | b8f5b25933e67dff215683014a49919e |
|
BLAKE2b-256 | 5da179a3f573aa65318f2be56f27ccd2816ee1875591f808ca7a72fdc4b9ea5e |
File details
Details for the file tsbot-1.3.1-py3-none-any.whl
.
File metadata
- Download URL: tsbot-1.3.1-py3-none-any.whl
- Upload date:
- Size: 30.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7042a567d28ba7aaa179cd96abc5ab1b44857b894947d295a47f888c81409b14 |
|
MD5 | cb178cb20332e43f3788c663d4252ce1 |
|
BLAKE2b-256 | 2818a981cde75baea259793e61f8b522e41bcfcc90b69ad4e5832f2ec188a1df |