# TikTokLiveWrapper
This project allows you to connect to TikTok livestreams and access available data using a creator's `@username`. It is designed to retrieve information from TikTok livestreams and cannot be used to post content or simulate interactions.
## Getting Started
1. Install the module:
pip install TikTokLiveWrapper
## Create a connection to the chat:
from TikTokLiveWrapper import TikTokLiveClient
from TikTokLiveWrapper.events import ConnectEvent, CommentEvent
client = TikTokLiveClient(unique_id="@username")
@client.on(ConnectEvent)
async def on_connect(event):
print(f"Connected to @{event.unique_id}")
async def on_comment(event):
print(f"{event.user.nickname} -> {event.comment}")
client.add_listener(CommentEvent, on_comment)
client.run()
## Key Methods
- run: Connect to the livestream.
- add_listener: Add a listener for events.
## Events
Available events include: ConnectEvent, CommentEvent.
## License
MIT License. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "TikTokLiveWrapper",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "tiktok, livestream, python, client, api, unofficial",
"author": "Nico",
"author_email": "nicopizzolorusso.np@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e1/1b/2cb28be1262eb7d39e5425bbdd4749226050e582437dd540e6bc421d1dee/tiktoklivewrapper-1.0.0.tar.gz",
"platform": null,
"description": "# TikTokLiveWrapper\r\n\r\nThis project allows you to connect to TikTok livestreams and access available data using a creator's `@username`. It is designed to retrieve information from TikTok livestreams and cannot be used to post content or simulate interactions.\r\n\r\n## Getting Started\r\n\r\n1. Install the module:\r\n\r\n pip install TikTokLiveWrapper\r\n\r\n\r\n## Create a connection to the chat:\r\n from TikTokLiveWrapper import TikTokLiveClient\r\n from TikTokLiveWrapper.events import ConnectEvent, CommentEvent\r\n\r\n client = TikTokLiveClient(unique_id=\"@username\")\r\n\r\n @client.on(ConnectEvent)\r\n async def on_connect(event):\r\n print(f\"Connected to @{event.unique_id}\")\r\n\r\n async def on_comment(event):\r\n print(f\"{event.user.nickname} -> {event.comment}\")\r\n\r\n client.add_listener(CommentEvent, on_comment)\r\n\r\n client.run()\r\n\r\n\r\n## Key Methods\r\n- run: Connect to the livestream.\r\n- add_listener: Add a listener for events.\r\n\r\n## Events\r\nAvailable events include: ConnectEvent, CommentEvent.\r\n\r\n## License\r\nMIT License. See the LICENSE file for details.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Unofficial Python API wrapper for TikTok Live",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"tiktok",
" livestream",
" python",
" client",
" api",
" unofficial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e11b2cb28be1262eb7d39e5425bbdd4749226050e582437dd540e6bc421d1dee",
"md5": "7efd9e1e8ca03a72cd6984b2e51ee593",
"sha256": "87f41235f771b5965588e2c1a74e868a4fba896df2841072ff688e7ea44ca771"
},
"downloads": -1,
"filename": "tiktoklivewrapper-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7efd9e1e8ca03a72cd6984b2e51ee593",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 42645,
"upload_time": "2024-09-26T16:10:35",
"upload_time_iso_8601": "2024-09-26T16:10:35.025457Z",
"url": "https://files.pythonhosted.org/packages/e1/1b/2cb28be1262eb7d39e5425bbdd4749226050e582437dd540e6bc421d1dee/tiktoklivewrapper-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 16:10:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tiktoklivewrapper"
}
JSON