| Name | tsbot JSON |
| Version |
1.7.1
JSON |
| download |
| home_page | None |
| Summary | Asynchronous Python framework to build TeamSpeak 3 Server Query bots |
| upload_time | 2025-07-10 20:34:39 |
| maintainer | None |
| docs_url | None |
| author | jykob |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2024 jykob
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# TSBot [](https://pypi.org/project/tsbot/)
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
```python
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](https://github.com/jykob/TSBot/blob/main/examples) for more**
## 📦 Installation
**Python 3.10 or higher is required**
Installing with pip:
```shell
# Linux/macOS
python3 -m pip install tsbot
# Windows
py -3 -m pip install tsbot
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tsbot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "jykob",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a9/74/3486eb7d02085b02a170d53b9b6b19054be86eb2871a23c917019438a77a/tsbot-1.7.1.tar.gz",
"platform": null,
"description": "# TSBot [](https://pypi.org/project/tsbot/)\n\nAsynchronous Python framework to build **TeamSpeak 3 Server Query** bots\n\n## \u2705 Features\n\n- Modern Python `async` and `await` syntax\n- Fully typed interface\n- Event, command and background task systems\n- Secure connection through SSH, or raw connection for local servers\n- Ease of use query building\n- Automatic reconnection if connection is lost\n- Built-in and configurable ratelimiter if no access to `query_ip_allowlist.txt`\n\n## \u270f\ufe0f Examples\n\n```python\nfrom __future__ import annotations\n\nimport asyncio\n\nfrom tsbot import TSBot, TSCtx, query\n\n\nbot = TSBot(\n username=\"USERNAME\",\n password=\"PASSWORD\",\n address=\"ADDRESS\",\n)\n\n\n@bot.command(\"hello\")\nasync def hello_world(bot: TSBot, ctx: TSCtx):\n await bot.respond(ctx, f\"Hello {ctx['invokername']}!\")\n\n\n@bot.on(\"cliententerview\")\nasync def poke_on_enter(bot: TSBot, ctx: TSCtx):\n poke_query = query(\"clientpoke\").params(clid=ctx[\"clid\"], msg=\"Welcome to the server!\")\n await bot.send(poke_query)\n\n\nasyncio.run(bot.run())\n```\n\n**Check out [\ud83d\udcc1examples](https://github.com/jykob/TSBot/blob/main/examples) for more**\n\n## \ud83d\udce6 Installation\n\n**Python 3.10 or higher is required**\n\nInstalling with pip:\n\n```shell\n# Linux/macOS\npython3 -m pip install tsbot\n\n# Windows\npy -3 -m pip install tsbot\n```\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 jykob\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Asynchronous Python framework to build TeamSpeak 3 Server Query bots",
"version": "1.7.1",
"project_urls": {
"documentation": "https://tsbot.readthedocs.io/",
"repository": "https://github.com/jykob/tsbot"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "16821f7c05aca4340b77efdc13271e5a50bbe40d3b11f47d000cf7c136dd6083",
"md5": "da393a895a5cdb3074ac54f038cce806",
"sha256": "dc5e0b465be97c989d552e0e539582b4682afa76f29e6fdedb90d0027bb6af01"
},
"downloads": -1,
"filename": "tsbot-1.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da393a895a5cdb3074ac54f038cce806",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 36978,
"upload_time": "2025-07-10T20:34:38",
"upload_time_iso_8601": "2025-07-10T20:34:38.430889Z",
"url": "https://files.pythonhosted.org/packages/16/82/1f7c05aca4340b77efdc13271e5a50bbe40d3b11f47d000cf7c136dd6083/tsbot-1.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a9743486eb7d02085b02a170d53b9b6b19054be86eb2871a23c917019438a77a",
"md5": "4c8ad94de48d414aa634d5b9c42774a6",
"sha256": "7c2370b64d866b392792c0b6b521f1d323a90e9f4cff9b6ed4af420f1d9fe474"
},
"downloads": -1,
"filename": "tsbot-1.7.1.tar.gz",
"has_sig": false,
"md5_digest": "4c8ad94de48d414aa634d5b9c42774a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 33348,
"upload_time": "2025-07-10T20:34:39",
"upload_time_iso_8601": "2025-07-10T20:34:39.781580Z",
"url": "https://files.pythonhosted.org/packages/a9/74/3486eb7d02085b02a170d53b9b6b19054be86eb2871a23c917019438a77a/tsbot-1.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 20:34:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jykob",
"github_project": "tsbot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tsbot"
}
