| Name | teamtalk-py JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | a simple but powerful pythonic library for making bots for the TeamTalk5 Conferencing System |
| upload_time | 2024-11-23 15:17:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
teamtalk
teamtalk5
teamtalk sdk
conferencing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Teamtalk.py
[](http://teamtalkpy.readthedocs.io/en/latest)
[](https://github.com/JessicaTegner/teamtalk.py/actions/workflows/ci.yaml)
[](https://github.com/JessicaTegner/teamtalk.py/releases)
[](https://pypi.org/project/teamtalk.py/)
[](https://pypi.python.org/pypi/teamtalk.py/)
[](https://github.com/psf/black)
[](http://makeapullrequest.com)
teamtalk.py is a simple but powerful pythonic library for making bots for the [TeamTalk5 Conferencing System](https://bearware.dk/)
### Installing
Python 3.8 or higher is required
#### From PyPI
```bash
pip install teamtalk.py
```
#### From source
```bash
git clone https://github.com/JessicaTegner/teamtalk.py
cd teamtalk.py
uv sync
```
### Usage
```python
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](http://teamtalkpy.readthedocs.io/en/latest)
## 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](https://https://github.com/jessicaTegner/issues/new)_
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](LICENSE) file for details
Raw data
{
"_id": null,
"home_page": null,
"name": "teamtalk-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "teamtalk, teamtalk5, teamtalk sdk, conferencing",
"author": null,
"author_email": "JessicaTegner <jessica.tegner@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/71/99/89b7940cbada8f829294e2c983842c4827656383662de0c6e68479475b4e/teamtalk_py-1.3.0.tar.gz",
"platform": null,
"description": "# Teamtalk.py\n\n[](http://teamtalkpy.readthedocs.io/en/latest)\n[](https://github.com/JessicaTegner/teamtalk.py/actions/workflows/ci.yaml)\n[](https://github.com/JessicaTegner/teamtalk.py/releases)\n[](https://pypi.org/project/teamtalk.py/)\n[](https://pypi.python.org/pypi/teamtalk.py/)\n\n[](https://github.com/psf/black)\n[](http://makeapullrequest.com)\n\nteamtalk.py is a simple but powerful pythonic library for making bots for the [TeamTalk5 Conferencing System](https://bearware.dk/)\n\n\n### Installing\n\nPython 3.8 or higher is required\n\n#### From PyPI\n\n```bash\npip install teamtalk.py\n```\n\n#### From source\n\n```bash\ngit clone https://github.com/JessicaTegner/teamtalk.py\ncd teamtalk.py\nuv sync\n```\n\n\n### Usage\n\n```python\nimport teamtalk\n\nbot = teamtalk.TeamTalkBot()\n\n@bot.event\nasync def on_ready():\n test_server = teamtalk.TeamTalkServerInfo(\"localhost\", 10335, 10335, \"user\", \"pass\")\n await bot.add_server(test_server)\n\n@bot.event\nasync def on_message(message):\n if message.content.lower() == \"ping\":\n message.reply(\"pong\")\n\nbot.run()\n```\n\n\n## Documentation\n\nYou can find the full documentation [here](http://teamtalkpy.readthedocs.io/en/latest)\n\n\n\n## Troubleshooting\n\n#### Erro when downloading the teamtalk sdk\n\n\n```\nError: patoolib.util.PatoolError: could not find an executable program to extract format 7z; candidates are (7z,7za,7zr,unar),\n```\n\nSolution:\n\n```\n$ sudo apt install p7zip-full\n```\n\nExplanation:\n\nThe 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.\n\n\n## Contributing\n\nSo you want to contribute to teamtalk.py? Great! There are many ways to contribute to this project, and all contributions are welcome.\nIf you have found a bug, have a feature request or want to help improve documentation please [open an issue](https://https://github.com/jessicaTegner/issues/new)_\nYou can also donate to the projects maintainer (JessicaTegner) to help support the development of teamtalk.py:\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "a simple but powerful pythonic library for making bots for the TeamTalk5 Conferencing System",
"version": "1.3.0",
"project_urls": {
"Issue Tracker": "https://github.com/JessicaTegner/teamtalk.py/issues/"
},
"split_keywords": [
"teamtalk",
" teamtalk5",
" teamtalk sdk",
" conferencing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0270e14ccf2e8ddfe72a1a78fd35fcb52d736881d284deb97dc3450e4ef3c3c6",
"md5": "c991391b5361dc4de3c7221420552c16",
"sha256": "b1ef9a5315fc7e844e93fd637146edc3a2e4562213b39243535ebc5f8f999f8c"
},
"downloads": -1,
"filename": "teamtalk_py-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c991391b5361dc4de3c7221420552c16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 36306,
"upload_time": "2024-11-23T15:17:07",
"upload_time_iso_8601": "2024-11-23T15:17:07.799189Z",
"url": "https://files.pythonhosted.org/packages/02/70/e14ccf2e8ddfe72a1a78fd35fcb52d736881d284deb97dc3450e4ef3c3c6/teamtalk_py-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "719989b7940cbada8f829294e2c983842c4827656383662de0c6e68479475b4e",
"md5": "4e005b80e62f569483b33bcbed43fb6b",
"sha256": "73c3d2f102dce007fa5d882b31d7d7a2309a53c1eef4faf3e59f19d25d327486"
},
"downloads": -1,
"filename": "teamtalk_py-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4e005b80e62f569483b33bcbed43fb6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 30498,
"upload_time": "2024-11-23T15:17:09",
"upload_time_iso_8601": "2024-11-23T15:17:09.260038Z",
"url": "https://files.pythonhosted.org/packages/71/99/89b7940cbada8f829294e2c983842c4827656383662de0c6e68479475b4e/teamtalk_py-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 15:17:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JessicaTegner",
"github_project": "teamtalk.py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "teamtalk-py"
}
