Skip to main content

Asynchronous framework to build TeamSpeak 3 Server Query bots

Project description

TSBot   PyPI - Version

Asynchronous Python 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.2.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

tsbot-1.3.2-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tsbot-1.3.2.tar.gz
  • Upload date:
  • Size: 26.7 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.2.tar.gz
Algorithm Hash digest
SHA256 4e97200e976eafef751e71062286a1f8b382863d4152580c80c1f1309603f0c8
MD5 943d9c7e917b0e6666b54412ef379018
BLAKE2b-256 a7c66fe766df1c27596b3ab8dd788260257b82fcdb0963b35b0ac95bfbb36be2

See more details on using hashes here.

Provenance

The following attestation bundles were made for tsbot-1.3.2.tar.gz:

Publisher: publish.yaml on jykob/TSBot

Attestations:

File details

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

File metadata

  • Download URL: tsbot-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 31.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0c561d507b471a5415d34fe225085e3ac0458fc6ca3516bbcdafbd9f1eb92e8c
MD5 fd694572ffa594b94876e0cb8c02b80f
BLAKE2b-256 130fe84cf52e200b3067b39313e87301514f3bfcd14940f74520075fb032d3b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for tsbot-1.3.2-py3-none-any.whl:

Publisher: publish.yaml on jykob/TSBot

Attestations:

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