Asynchronous Python framework to build TeamSpeak 3 Server Query bots

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for jykob from gravatar.com jykob

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License)
  • Author: jykob
  • Requires: Python >=3.10
  • Provides-Extra: dev , tests , docs
Classifiers
Report project as malware

Project description

TSBot   PyPI - Version

Asynchronous Python framework to build TeamSpeak 3 Server Query bots

✅ Features

  • Modern Python async and await syntax
  • Fully typed interface
  • Event, command and background task systems
  • Secure connection through SSH, or raw connection for local servers
  • Ease of use query building
  • Automatic reconnection if connection is lost
  • 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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for jykob from gravatar.com jykob

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License)
  • Author: jykob
  • Requires: Python >=3.10
  • Provides-Extra: dev , tests , docs
Classifiers

Release history Release notifications | RSS feed

This version

1.7.1

1.7.0

1.6.2

1.6.1

1.6.0

1.5.1

1.5.0

1.4.1

1.4.0

1.3.2

1.3.1

1.3.0 yanked

Reason this release was yanked:

Race condition when sending queries

1.2.2

1.2.1

1.2.0 yanked

Reason this release was yanked:

Improper packaging

1.1.2

1.1.1

1.1.0

1.0.0

0.18.0

0.17.2

0.17.1

0.17.0

0.16.3

0.16.2

0.16.1

0.16.0

0.15.1

0.15.0

0.14.0

0.13.1

0.13.0

0.12.6

0.12.0

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.7.1.tar.gz (33.3 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.7.1-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tsbot-1.7.1.tar.gz
Algorithm Hash digest
SHA256 7c2370b64d866b392792c0b6b521f1d323a90e9f4cff9b6ed4af420f1d9fe474
MD5 4c8ad94de48d414aa634d5b9c42774a6
BLAKE2b-256 a9743486eb7d02085b02a170d53b9b6b19054be86eb2871a23c917019438a77a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: tsbot-1.7.1-py3-none-any.whl
  • Upload date:
  • Size: 37.0 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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc5e0b465be97c989d552e0e539582b4682afa76f29e6fdedb90d0027bb6af01
MD5 da393a895a5cdb3074ac54f038cce806
BLAKE2b-256 16821f7c05aca4340b77efdc13271e5a50bbe40d3b11f47d000cf7c136dd6083

See more details on using hashes here.

Provenance

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