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.2.tar.gz (32.1 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.2-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tsbot-1.6.2.tar.gz
  • Upload date:
  • Size: 32.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tsbot-1.6.2.tar.gz
Algorithm Hash digest
SHA256 3c3e302606ced6f977b82597c8410c4077b3732b6a2aee8ab7959dd70bc71876
MD5 b0602253f2725d56e77f8a6680db365a
BLAKE2b-256 489fc24d37ed008250ecfc36e219af4caa33dc3e43507aecb64fa14c03b816c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for tsbot-1.6.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: tsbot-1.6.2-py3-none-any.whl
  • Upload date:
  • Size: 35.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tsbot-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e48805e5793cf2b562eb0a522e20c4f503f7af7312da7fadc84bbb1aa41497d8
MD5 c6314eee3ff38417c474f786d3659adf
BLAKE2b-256 3a8e59c8d2e7fad045627836ba6ae889a2f87afa1e2683afd2b108d56cb61186

See more details on using hashes here.

Provenance

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