From f6c32d8be70bb0ff6236d6cd71d355b992648d73 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 20 Dec 2022 00:24:01 +0000 Subject: [PATCH] docs: Added README."en".md translation via https://github.com/dephraiim/translate-readme --- README.en.md | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/README.en.md b/README.en.md index d54dba7..311fe60 100644 --- a/README.en.md +++ b/README.en.md @@ -1,18 +1,26 @@ -# tkhub_pp([API.TikHub.io](https://api.tikhub.io/docs)) +
-[API.TikHub.io](https://api.tikhub.io/docs), is an asynchronous high-performance Douyin and TikTok data crawling tool. This Repo is a PyPi package based on this API, which is convenient for developers to call. +# [tikhub_pp](https://pypi.org/project/tikhub) + +ใ€Œ[api.tikhub.io](https://api.tikhub.io/docs)", is an asynchronous high-performance Douyin and TikTok data crawling online tool. This repo is a package based on this API, which is convenient for developers to call. + +Pee: + +[English](./README.en.md)\|[Simplified Chinese](./README.md) + +
## note > This project uses the following Emoji to indicate the development status in the development chart! -| Emoji | representative meaning | -| :---: | :-----------------------------------------------------------------------------------------------------------------: | -| ๐Ÿš€ | Rocket - The feature is written, tested, and deployed to production. | -| โœ… | Checkmark - The feature is written but has yet to be tested and will be deployed to production once the tests pass. | -| โŒ | Cross sign - The feature has not yet been written or has not been written yet. | -| ๐Ÿ”œ | SOON BREAK - Feature proposed but not yet assigned a designated developer. | -| โš ๏ธ | Warning symbol - There is a problem with the function that needs to be fixed. | +| Emoji | representative meaning | +| :---: | :-------------------------------------------------------------------------------------------------------------------: | +| ๐Ÿš€ | Rocket - The feature is written, tested, and deployed to production. | +| โœ… | Check mark - the feature is written, but has yet to be tested and will be deployed to production once the tests pass. | +| โŒ | Cross sign - Feature has not yet been written or has not been written yet. | +| ๐Ÿ”œ | SOON็ฌฆ - ๅŠŸ่ƒฝๅทฒๆๅ‡บไฝ†ๅฐšๆœชๅˆ†้…ๆŒ‡ๅฎšๅผ€ๅ‘ไบบๅ‘˜ใ€‚ | +| โš ๏ธ | Warning symbol - There is a problem with the function that needs to be fixed. | ## project progress @@ -41,11 +49,11 @@ | ๐Ÿš€ | `/douyin_profile_videos/` | Crawl user homepage video data | no known issues | | ๐Ÿš€ | `/douyin_profile_liked_videos/` | Crawl the user homepage has liked the video data | no known issues | -> Production deployment of TikTok-related interfaces - API tags: TikTok +> Production and deployment of TikTok-related interfaces - API tags: TikTok | state | API endpoint path | Function | issue | | :---: | :-----------------------------: | :----------------------------------------------: | :-------------: | -| ๐Ÿš€ | `/tiktok_video_data/` | Crawl a single video data | no known issues | +| ๐Ÿš€ | `/tiktok_video_data/` | Crawl a single video data | ๆ— ๅทฒ็Ÿฅ้—ฎ้ข˜ | | ๐Ÿš€ | `/tiktok_video_comments/` | Crawl a single video comment data | no known issues | | ๐Ÿš€ | `/tiktok_music_videos/` | Crawl the soundtrack data | no known issues | | ๐Ÿš€ | `/tiktok_profile_videos/` | Crawl user homepage video data | no known issues | @@ -58,7 +66,14 @@ ## Example of use +> Check[demo.py](https://github.com/TikHubIO/TikHub_PyPi/blob/main/demo/demo.py) + ```python +import asyncio +import time + +from tikhub.api import API + async def async_test() -> None: # ๅผ‚ๆญฅๆต‹่ฏ•/Async test @@ -68,7 +83,7 @@ async def async_test() -> None: douyin_url = 'https://www.douyin.com/video/7153585499477757192' - douyin_user_url = 'https://www.douyin.com/user/MS4wLjABAAAA-Hu1YKTuhE3QkCHD5yU26k--RUZiaoMRtpfmeid-Z_o' + douyin_user_url = 'https://www.douyin.com/user/MS4wLjABAAAAaNJuvXC83kL5nhaZHubKdjsRJQovgz58wXzlLnJUsslG-Kb24TM1QJlf_2HMaUJk' print("Test start...\n") start_time = time.time() @@ -121,6 +136,7 @@ async def async_test() -> None: # ่Žทๅ–็”จๆˆทไธป้กต็š„ๆ‰€ๆœ‰็‚น่ตž่ง†้ข‘ๆ•ฐๆฎ/Get all liked video data on the user's homepage print("Running test : API.get_douyin_profile_liked_videos()") aweme_list = await api.get_douyin_profile_liked_videos(douyin_user_url, 20) + print(f'Get {len(aweme_list)} liked videos from profile') # ๆ€ป่€—ๆ—ถ/Total time total_time = round(time.time() - start_time, 2)