Skip to content

Commit

Permalink
docs: Added README."en".md translation via https://github.com/dephrai…
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 20, 2024
1 parent fce0750 commit c33095a
Showing 1 changed file with 33 additions and 30 deletions.
63 changes: 33 additions & 30 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

> 🚨If you need to use a private server to run this project, please refer to:[Deployment preparations](./README.md#%EF%B8%8F%E9%83%A8%E7%BD%B2%E5%89%8D%E7%9A%84%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C%E8%AF%B7%E4%BB%94%E7%BB%86%E9%98%85%E8%AF%BB),[Docker deployment](./README.md#%E9%83%A8%E7%BD%B2%E6%96%B9%E5%BC%8F%E4%BA%8C-docker),[One-click deployment](./README.md#%E9%83%A8%E7%BD%B2%E6%96%B9%E5%BC%8F%E4%B8%80-linux)
This project is based on[PyWebIO](https://github.com/pywebio/PyWebIO)[FastAPI](https://fastapi.tiangolo.com/)[HTTPX](https://www.python-httpx.org/), fast and asynchronous[Tik Tok](https://www.douyin.com/)/[TikTok](https://www.tiktok.com/)Data crawling tool, and realizes online batch analysis and downloading of videos or photo albums without watermarks through the Web, data crawling API, iOS shortcut command without watermark downloads and other functions. You can deploy or modify this project yourself to achieve more functions, or you can call it directly in your project[scraper.py](https://github.com/Evil0ctal/Douyin_TikTok_Download_API/blob/Stable/scraper.py)or install an existing[pip package](https://pypi.org/project/douyin-tiktok-scraper/)As a parsing library, it is easy to crawl data, etc.....
This project is based on[PyWebIO](https://github.com/pywebio/PyWebIO)[FastAPI](https://fastapi.tiangolo.com/)[HTTPX](https://www.python-httpx.org/), fast and asynchronous[Tik Tok](https://www.douyin.com/)/[TikTok](https://www.tiktok.com/)Data crawling tool, and realizes online batch parsing and downloading of videos or photo albums without watermarks, data crawling API, and iOS shortcut commands without watermark downloads through the Web. You can deploy or modify this project yourself to achieve more functions, or you can call it directly in your project[scraper.py](https://github.com/Evil0ctal/Douyin_TikTok_Download_API/blob/Stable/scraper.py)or install an existing[pip package](https://pypi.org/project/douyin-tiktok-scraper/)As a parsing library, it is easy to crawl data, etc.....

_Some simple application scenarios:_

Expand Down Expand Up @@ -62,7 +62,7 @@ Part of TikHub's source code will be open sourced on Github, and it will sponsor

## 🖥Demo site: I am very vulnerable...please do not stress test (·•᷄ࡇ•᷅ )

> 😾The online download function of the demo site has been turned off, and due to cookie reasons, the availability of Douyin's parsing and API services cannot be guaranteed on the Demo site.
> 😾The online download function of the demo site has been turned off, and due to cookie reasons, Douyin's parsing and API services cannot guarantee availability on the Demo site.
🍔Web APP:<https://douyin.wtf/>

Expand Down Expand Up @@ -94,7 +94,7 @@ Part of TikHub's source code will be open sourced on Github, and it will sponsor

> **_/app/web_**
- use`PyWebIO`A simple web program created to process the values ​​entered on the web page and use them`Crawlers`The related class processing interface outputs related data on the web page.
- use`PyWebIO`A simple web program created to process the values ​​entered on the web page and then use them`Crawlers`The related class processing interface outputs related data on the web page.

**_Most of the parameters of the above files can be found in the corresponding`config.yaml`Make changes in_**

Expand All @@ -109,13 +109,15 @@ Part of TikHub's source code will be open sourced on Github, and it will sponsor
│ └─web
│ └─views
└─crawlers
├─douyin
│ └─web
├─hybrid
├─tiktok
│ ├─app
│ └─web
└─utils
├─bilibili
│ └─web
├─douyin
│ └─web
├─hybrid
├─tiktok
│ ├─app
│ └─web
└─utils

## ✨Supported functions:

Expand All @@ -125,15 +127,15 @@ Part of TikHub's source code will be open sourced on Github, and it will sponsor
- [iOS shortcut commands to quickly call API](https://apps.apple.com/cn/app/%E5%BF%AB%E6%8D%B7%E6%8C%87%E4%BB%A4/id915249334)Achieve in-app download of watermark-free videos/photo albums
- Complete API documentation ([Demo/Demonstration](https://api.douyin.wtf/docs))
- Rich API interface:
- Douyin web version API
- Douyin web version API

- [x] Video data analysis
- [x] Get user homepage work data
- [x] Obtain the data of works liked by the user's homepage
- [x] Obtain the data of collected works on the user's homepage
- [x] Get user homepage information
- [x] Get user collection work data
- [x] Get user live streaming data
- [x] Get user live stream data
- [x] Get the live streaming data of a specified user
- [x] Get the ranking of users who give gifts in the live broadcast room
- [x] Get single video comment data
Expand All @@ -149,13 +151,13 @@ Part of TikHub's source code will be open sourced on Github, and it will sponsor
- [x] Extract list work id
- [x] Extract live broadcast room number from list
- [x] Extract live broadcast room number from list
- TikTok web version API
- TikTok web version API

- [x] Video data analysis
- [x] Get user homepage work data
- [x] Obtain the data of works liked by the user's homepage
- [x] Get user homepage information
- [x] Get user homepage fan data
- [x] Get fan data on user homepage
- [x] Get user homepage follow data
- [x] Get user homepage collection work data
- [x] Get user homepage collection data
Expand All @@ -171,18 +173,19 @@ Part of TikHub's source code will be open sourced on Github, and it will sponsor
- [x] Extract list work id
- [x] Get user unique_id
- [x] Get list unique_id
- Bilibili web version API
- [x] Get single video data
- [x] Get user homepage video data
- [x] Get user collection folders
- [x] Gets video data from a collection folder
- [x] Get information of specified user
- [x] Get comprehensive popular video information
- [x] Get comments on the specified video
- [x] Get reply to the specified comment
- [x] Get dynamic information of specified user
- [x] Get information of specified live room
- [x] Get a list of all live areas
- Bilibili web version API
- [x] Get individual video details
- [x] Obtain user-published video work data
- [x] Get all the user's favorites information
- [x] Get video data in specified favorites
- [x] Get information about a specified user
- [x] Get comprehensive popular video information
- [x] Get comments for specified video
- [x] Get the reply to the specified comment under the video
- [x] Get the specified user's updates
- [x] Get specified live broadcast room information
- [x] Get a list of all live broadcast partitions

* * *

## 📦Call the parsing library (obsolete and needs to be updated):
Expand Down Expand Up @@ -274,7 +277,7 @@ Online:<https://api.douyin.wtf/docs>

## ⚠️Preparation work before deployment (please read carefully):

- You need to solve the problem of crawler cookie risk control by yourself, otherwise the interface may become unusable. After modifying the configuration file, you need to restart the service for it to take effect, and it is best to use cookies from accounts that you have already logged in to.
- You need to solve the problem of crawler cookie risk control by yourself, otherwise the interface may become unusable. After modifying the configuration file, you need to restart the service for it to take effect. It is best to use the cookie of the account you have already logged in to.
- Douyin web cookie (obtain and replace the cookie in the configuration file below):
- <https://github.com/Evil0ctal/Douyin_TikTok_Download_API/blob/30e56e5a7f97f87d60b1045befb1f6db147f8590/crawlers/douyin/web/config.yaml#L7>
- TikTok web-side cookies (obtain and replace the cookies in the configuration file below):
Expand Down Expand Up @@ -313,7 +316,7 @@ My invitation link:

> Turn on/off automatic operation at startup
- Use the following command to set the service to run automatically at boot or cancel automatic run at boot:
- Use the following commands to set the service to run automatically at boot or cancel automatic run at boot:
- `sudo systemctl enable Douyin_TikTok_Download_API.service`
- `sudo systemctl disable Douyin_TikTok_Download_API.service`

Expand Down Expand Up @@ -368,7 +371,7 @@ This will list all active containers. Find`douyin_tiktok_api `to confirm that it

### Step 4: Access the App

Once the container is running, you should be able to pass`http://localhost`Or API client access Douyin_TikTok_Download_API. If a different port is configured or accessed from a remote location, adjust the URL.
Once the container is running, you should be able to pass`http://localhost`Or API client access Douyin_TikTok_Download_API. Adjust the URL if a different port is configured or accessed from a remote location.

### Optional: Custom Docker commands

Expand All @@ -394,7 +397,7 @@ Most of the configuration of the project can be found in the following directori

### Step 5: Stop and remove the container

When you need to stop and remove containers, use the following commands:
When you need to stop and remove a container, use the following commands:

```bash
# Stop
Expand Down

0 comments on commit c33095a

Please sign in to comment.