Skip to main content

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tsbot-1.6.1-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tsbot-1.6.1.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for tsbot-1.6.1.tar.gz
Algorithm Hash digest
SHA256 e1750fec192ffb0ab5e20359ccf7dd4d530e658d744382906c04b196017b4ead
MD5 00974fe91c82b327318c3d12c9ef21a6
BLAKE2b-256 a765f0edd495931846a36aca809813e910cc5f63374798ac183d4e3e2285b91f

See more details on using hashes here.

Provenance

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

Publisher: publish.yaml on jykob/TSBot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: tsbot-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 34.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for tsbot-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 87982f9e3cb25ccb070f315e71310c2fa69a1296eb5307d261eb765b69f93b37
MD5 7cc9176d05de984d8f72ee1c964a3c36
BLAKE2b-256 c3e45a908d13a61fca8b8afbd6d32366201549a9e53cf1d0d0a77f34e78d49f6

See more details on using hashes here.

Provenance

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

Publisher: publish.yaml on jykob/TSBot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page