README.md

Teamtalk.py

teamtalk.py is a simple but powerful pythonic library for making bots for the TeamTalk5 Conferencing System

Installing

Python 3.8 or higher is required

From PyPI

pip install teamtalk.py

From source

git clone https://github.com/JessicaTegner/teamtalk.py
cd teamtalk.py
uv sync

Usage

import teamtalk

bot = teamtalk.TeamTalkBot()

@bot.event
async def on_ready():
    test_server = teamtalk.TeamTalkServerInfo("localhost", 10335, 10335, "user", "pass")
    await bot.add_server(test_server)

@bot.event
async def on_message(message):
    if message.content.lower() == "ping":
        message.reply("pong")

bot.run()

Documentation

You can find the full documentation here

Troubleshooting

Erro when downloading the teamtalk sdk

Error: patoolib.util.PatoolError: could not find an executable program to extract format 7z; candidates are (7z,7za,7zr,unar),

Solution:

$ sudo apt install p7zip-full

Explanation:

The error is caused by the fact that the patool library requires a program to extract 7z files. The error message lists the programs it tried to use, and the solution is to install one of them. In this case, p7zip-full is a good choice.

Contributing

So you want to contribute to teamtalk.py? Great! There are many ways to contribute to this project, and all contributions are welcome. If you have found a bug, have a feature request or want to help improve documentation please open an issue_ You can also donate to the projects maintainer (JessicaTegner) to help support the development of teamtalk.py:

License

This project is licensed under the MIT License - see the LICENSE file for details