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

Uploaded Source

Built Distribution

tsbot-1.4.1-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

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

Hashes for tsbot-1.4.1.tar.gz
Algorithm Hash digest
SHA256 51bccf83534a47dac7b4c51db4101b7b7d0d58a5412d46fd5d28e0536f4ab5af
MD5 f6a8701622a8fbbd1c5bf9f9ba27a5ae
BLAKE2b-256 993d7052f81f469caa0fb834c0a05c12850e1649a9693a027c062e9f289e7021

See more details on using hashes here.

Provenance

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

Publisher: publish.yaml on jykob/TSBot

Attestations:

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

Hashes for tsbot-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be0b5e7b1f1b88eeaa09ff0d43e04ecdeca2a95c043e7f323d09a3b0af731435
MD5 36e7647ddae242ccca117246e3bd3d80
BLAKE2b-256 8db5af0edf6bb324b137e0d03b3bf10872ed06192921d5054cb0a06a4aef58af

See more details on using hashes here.

Provenance

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