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.4.0.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

tsbot-1.4.0-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tsbot-1.4.0.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for tsbot-1.4.0.tar.gz
Algorithm Hash digest
SHA256 e94654c0177181f23ae9af38a436371bf8addead92d2cb4f9f44c166cbc43875
MD5 9eecf6813130a361d81416667df4e57e
BLAKE2b-256 f08146b6da74f3c5ad55f91ae7877abd95a903575bc7e828dcef38524ac4d194

See more details on using hashes here.

Provenance

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

Publisher: publish.yaml on jykob/TSBot

Attestations:

File details

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

File metadata

  • Download URL: tsbot-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 32.2 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca24f077fae4a3900cda765c4af3ccf8692f51a6df15769fe94f70eb540db012
MD5 29faebf32dad8e373fa5922577f22b78
BLAKE2b-256 9fd56d7480edc13dd943b55d41b64048e0e030c890615bb21673c75e84e3c64e

See more details on using hashes here.

Provenance

The following attestation bundles were made for tsbot-1.4.0-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