Asynchronous Python 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.4.1.tar.gz
(27.3 kB
view details)
Built Distribution
tsbot-1.4.1-py3-none-any.whl
(32.3 kB
view details)
File details
Details for the file tsbot-1.4.1.tar.gz
.
File metadata
- Download URL: tsbot-1.4.1.tar.gz
- Upload date:
- Size: 27.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51bccf83534a47dac7b4c51db4101b7b7d0d58a5412d46fd5d28e0536f4ab5af |
|
MD5 | f6a8701622a8fbbd1c5bf9f9ba27a5ae |
|
BLAKE2b-256 | 993d7052f81f469caa0fb834c0a05c12850e1649a9693a027c062e9f289e7021 |
Provenance
The following attestation bundles were made for tsbot-1.4.1.tar.gz
:
Publisher:
publish.yaml
on jykob/TSBot
-
Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
tsbot-1.4.1.tar.gz
- Subject digest:
51bccf83534a47dac7b4c51db4101b7b7d0d58a5412d46fd5d28e0536f4ab5af
- Sigstore transparency entry: 146152566
- Sigstore integration time:
- Predicate type:
File details
Details for the file tsbot-1.4.1-py3-none-any.whl
.
File metadata
- Download URL: tsbot-1.4.1-py3-none-any.whl
- Upload date:
- Size: 32.3 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 | be0b5e7b1f1b88eeaa09ff0d43e04ecdeca2a95c043e7f323d09a3b0af731435 |
|
MD5 | 36e7647ddae242ccca117246e3bd3d80 |
|
BLAKE2b-256 | 8db5af0edf6bb324b137e0d03b3bf10872ed06192921d5054cb0a06a4aef58af |
Provenance
The following attestation bundles were made for tsbot-1.4.1-py3-none-any.whl
:
Publisher:
publish.yaml
on jykob/TSBot
-
Statement type:
https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
tsbot-1.4.1-py3-none-any.whl
- Subject digest:
be0b5e7b1f1b88eeaa09ff0d43e04ecdeca2a95c043e7f323d09a3b0af731435
- Sigstore transparency entry: 146152567
- Sigstore integration time:
- Predicate type: