mirror of
https://github.com/JoeanAmier/XHS-Downloader.git
synced 2026-03-22 06:57:16 +08:00
docs: Update ReadMe
This commit is contained in:
1
.github/dependabot.yml
vendored
1
.github/dependabot.yml
vendored
@@ -10,5 +10,6 @@ updates:
|
|||||||
interval: "cron"
|
interval: "cron"
|
||||||
cronjob: "0 0 * * 6"
|
cronjob: "0 0 * * 6"
|
||||||
timezone: "Asia/Shanghai"
|
timezone: "Asia/Shanghai"
|
||||||
|
target-branch: "develop"
|
||||||
registries:
|
registries:
|
||||||
- pip_mirror
|
- pip_mirror
|
||||||
|
|||||||
@@ -75,6 +75,7 @@
|
|||||||
<p>⭐ 推荐使用 <a href="https://learn.microsoft.com/zh-cn/windows/terminal/install">Windows 终端</a> (Windows 11 默认终端)运行程序以便获得最佳显示效果!</p>
|
<p>⭐ 推荐使用 <a href="https://learn.microsoft.com/zh-cn/windows/terminal/install">Windows 终端</a> (Windows 11 默认终端)运行程序以便获得最佳显示效果!</p>
|
||||||
<h1>🥣 使用方法</h1>
|
<h1>🥣 使用方法</h1>
|
||||||
<p>如果仅需下载作品文件,建议选择 <b>程序运行</b> 或 <b>Docker 运行</b>;如果有其他需求,建议选择 <b>源码运行</b>!</p>
|
<p>如果仅需下载作品文件,建议选择 <b>程序运行</b> 或 <b>Docker 运行</b>;如果有其他需求,建议选择 <b>源码运行</b>!</p>
|
||||||
|
<p>⚠️ Cookie 配置为非强制项;如遇功能异常,建议配置或更新 Cookie 后再次尝试!</p>
|
||||||
<p>⚠️ 未设置 Cookie 时,视频作品只能下载低分辨率文件;建议配置 Cookie 以获取更高画质(无需登录账号)!</p>
|
<p>⚠️ 未设置 Cookie 时,视频作品只能下载低分辨率文件;建议配置 Cookie 以获取更高画质(无需登录账号)!</p>
|
||||||
<h2>🖱 程序运行</h2>
|
<h2>🖱 程序运行</h2>
|
||||||
<p>⭐ Mac OS、Windows 10 及以上用户可前往 <a href="https://github.com/JoeanAmier/XHS-Downloader/releases/latest">Releases</a> 或者 <a href="https://github.com/JoeanAmier/XHS-Downloader/actions">Actions</a> 下载程序压缩包,解压后打开程序文件夹,双击运行 <code>main</code> 即可使用。</p>
|
<p>⭐ Mac OS、Windows 10 及以上用户可前往 <a href="https://github.com/JoeanAmier/XHS-Downloader/releases/latest">Releases</a> 或者 <a href="https://github.com/JoeanAmier/XHS-Downloader/actions">Actions</a> 下载程序压缩包,解压后打开程序文件夹,双击运行 <code>main</code> 即可使用。</p>
|
||||||
@@ -236,7 +237,7 @@ async def example_api():
|
|||||||
<h1>📜 其他说明</h1>
|
<h1>📜 其他说明</h1>
|
||||||
<ul>
|
<ul>
|
||||||
<li>由于作品链接携带日期信息,使用先前日期获取的作品链接可能会被风控,建议下载作品文件时使用最新获取的作品链接</li>
|
<li>由于作品链接携带日期信息,使用先前日期获取的作品链接可能会被风控,建议下载作品文件时使用最新获取的作品链接</li>
|
||||||
<li>Windows 系统需要以管理员身份运行程序才能读取 Chromium、Chrome、Edge 浏览器 Cookie</li>
|
<li><del>Windows 系统需要以管理员身份运行程序才能读取 Chromium、Chrome、Edge 浏览器 Cookie</del></li>
|
||||||
<li>如果开启保存作品数据至文件功能,作品数据默认储存至 <code>./Volume/Download/ExploreData.db</code> 文件</li>
|
<li>如果开启保存作品数据至文件功能,作品数据默认储存至 <code>./Volume/Download/ExploreData.db</code> 文件</li>
|
||||||
<li>程序下载记录数据储存至 <code>./Volume/ExploreID.db</code> 文件</li>
|
<li>程序下载记录数据储存至 <code>./Volume/ExploreID.db</code> 文件</li>
|
||||||
<li>为了避免请求频率过高对平台服务器造成影响,本项目内置请求延时机制</li>
|
<li>为了避免请求频率过高对平台服务器造成影响,本项目内置请求延时机制</li>
|
||||||
@@ -307,7 +308,7 @@ async def example():
|
|||||||
language = "zh_CN" # 设置程序提示语言
|
language = "zh_CN" # 设置程序提示语言
|
||||||
author_archive = True # 是否将每个作者的作品存至单独的文件夹
|
author_archive = True # 是否将每个作者的作品存至单独的文件夹
|
||||||
write_mtime = True # 是否将作品文件的 修改时间 修改为作品的发布时间
|
write_mtime = True # 是否将作品文件的 修改时间 修改为作品的发布时间
|
||||||
read_cookie = None # 读取浏览器 Cookie,支持设置浏览器名称(字符串)或者浏览器序号(整数),设置为 None 代表不读取
|
# read_cookie = None # 读取浏览器 Cookie,支持设置浏览器名称(字符串)或者浏览器序号(整数),设置为 None 代表不读取
|
||||||
# async with XHS() as xhs:
|
# async with XHS() as xhs:
|
||||||
# pass # 使用默认参数
|
# pass # 使用默认参数
|
||||||
async with XHS(
|
async with XHS(
|
||||||
@@ -328,7 +329,7 @@ async def example():
|
|||||||
live_download=live_download,
|
live_download=live_download,
|
||||||
download_record=download_record,
|
download_record=download_record,
|
||||||
language=language,
|
language=language,
|
||||||
read_cookie=read_cookie,
|
# read_cookie=read_cookie,
|
||||||
author_archive=author_archive,
|
author_archive=author_archive,
|
||||||
write_mtime=write_mtime,
|
write_mtime=write_mtime,
|
||||||
) as xhs: # 使用自定义参数
|
) as xhs: # 使用自定义参数
|
||||||
|
|||||||
@@ -76,6 +76,7 @@
|
|||||||
<p>⭐ It is recommended to use the <a href="https://learn.microsoft.com/en-us/windows/terminal/install">Windows Terminal</a> (default terminal for Windows 11) to run the program for the best display effect!</p>
|
<p>⭐ It is recommended to use the <a href="https://learn.microsoft.com/en-us/windows/terminal/install">Windows Terminal</a> (default terminal for Windows 11) to run the program for the best display effect!</p>
|
||||||
<h1>🥣 Usage</h1>
|
<h1>🥣 Usage</h1>
|
||||||
<p>If you only need to download notes files, it is recommended to choose <b>Program Run</b>; if you have other needs, it is recommended to choose <b>Source Code Run</b>!</p>
|
<p>If you only need to download notes files, it is recommended to choose <b>Program Run</b>; if you have other needs, it is recommended to choose <b>Source Code Run</b>!</p>
|
||||||
|
<p>⚠️ Cookies are optional. If issues occur, please try configuring or updating them and retry!</p>
|
||||||
<p>⚠️ When Cookie is not set, video works can only be downloaded in low resolution; it is recommended to configure Cookie to obtain higher quality (no need to log in to the account)!</p>
|
<p>⚠️ When Cookie is not set, video works can only be downloaded in low resolution; it is recommended to configure Cookie to obtain higher quality (no need to log in to the account)!</p>
|
||||||
<h2>🖱 Program Run</h2>
|
<h2>🖱 Program Run</h2>
|
||||||
<p>⭐ Mac OS, Windows 10 and above users can go to <a href="https://github.com/JoeanAmier/XHS-Downloader/releases/latest">Releases</a> or <a href="https://github.com/JoeanAmier/XHS-Downloader/actions">Actions</a> to download the program package, unzip it, open the program folder, and double-click to run <code>main</code> to use.</p>
|
<p>⭐ Mac OS, Windows 10 and above users can go to <a href="https://github.com/JoeanAmier/XHS-Downloader/releases/latest">Releases</a> or <a href="https://github.com/JoeanAmier/XHS-Downloader/actions">Actions</a> to download the program package, unzip it, open the program folder, and double-click to run <code>main</code> to use.</p>
|
||||||
@@ -240,7 +241,7 @@ async def example_api():
|
|||||||
<h1>📜 Others</h1>
|
<h1>📜 Others</h1>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Due to the date information carried in the links of RedNote notes, using links obtained from previous dates may be subject to risk control. It is recommended to use the latest RedNote notes links when downloading RedNote work files</li>
|
<li>Due to the date information carried in the links of RedNote notes, using links obtained from previous dates may be subject to risk control. It is recommended to use the latest RedNote notes links when downloading RedNote work files</li>
|
||||||
<li>Windows system requires running programs as an administrator to read Chromium, Chrome, Edge browser cookies</li>
|
<li><del>Windows system requires running programs as an administrator to read Chromium, Chrome, Edge browser cookies</del></li>
|
||||||
<li>If the function to save notes data to a file is enabled, the notes data will be stored by default in the <code>./Volume/Download/ExploreData.db</code> file</li>
|
<li>If the function to save notes data to a file is enabled, the notes data will be stored by default in the <code>./Volume/Download/ExploreData.db</code> file</li>
|
||||||
<li>The program's download records will be stored in the <code>./Volume/ExploreID.db</code> file</li>
|
<li>The program's download records will be stored in the <code>./Volume/ExploreID.db</code> file</li>
|
||||||
<li>To prevent high-frequency requests from impacting the platform's servers, this project includes a built-in request delay mechanism</li>
|
<li>To prevent high-frequency requests from impacting the platform's servers, this project includes a built-in request delay mechanism</li>
|
||||||
@@ -311,7 +312,7 @@ async def example():
|
|||||||
language = "zh_CN" # 设置程序提示语言
|
language = "zh_CN" # 设置程序提示语言
|
||||||
author_archive = True # 是否将每个作者的作品存至单独的文件夹
|
author_archive = True # 是否将每个作者的作品存至单独的文件夹
|
||||||
write_mtime = True # 是否将作品文件的 修改时间 修改为作品的发布时间
|
write_mtime = True # 是否将作品文件的 修改时间 修改为作品的发布时间
|
||||||
read_cookie = None # 读取浏览器 Cookie,支持设置浏览器名称(字符串)或者浏览器序号(整数),设置为 None 代表不读取
|
# read_cookie = None # 读取浏览器 Cookie,支持设置浏览器名称(字符串)或者浏览器序号(整数),设置为 None 代表不读取
|
||||||
# async with XHS() as xhs:
|
# async with XHS() as xhs:
|
||||||
# pass # 使用默认参数
|
# pass # 使用默认参数
|
||||||
async with XHS(
|
async with XHS(
|
||||||
@@ -332,7 +333,7 @@ async def example():
|
|||||||
live_download=live_download,
|
live_download=live_download,
|
||||||
download_record=download_record,
|
download_record=download_record,
|
||||||
language=language,
|
language=language,
|
||||||
read_cookie=read_cookie,
|
# read_cookie=read_cookie,
|
||||||
author_archive=author_archive,
|
author_archive=author_archive,
|
||||||
write_mtime=write_mtime,
|
write_mtime=write_mtime,
|
||||||
) as xhs: # 使用自定义参数
|
) as xhs: # 使用自定义参数
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ async def example():
|
|||||||
language = "zh_CN" # 设置程序提示语言
|
language = "zh_CN" # 设置程序提示语言
|
||||||
author_archive = True # 是否将每个作者的作品存至单独的文件夹
|
author_archive = True # 是否将每个作者的作品存至单独的文件夹
|
||||||
write_mtime = True # 是否将作品文件的 修改时间 修改为作品的发布时间
|
write_mtime = True # 是否将作品文件的 修改时间 修改为作品的发布时间
|
||||||
read_cookie = None # 读取浏览器 Cookie,支持设置浏览器名称(字符串)或者浏览器序号(整数),设置为 None 代表不读取
|
# read_cookie = None # 读取浏览器 Cookie,支持设置浏览器名称(字符串)或者浏览器序号(整数),设置为 None 代表不读取
|
||||||
|
|
||||||
# async with XHS() as xhs:
|
# async with XHS() as xhs:
|
||||||
# pass # 使用默认参数
|
# pass # 使用默认参数
|
||||||
@@ -54,7 +54,7 @@ async def example():
|
|||||||
live_download=live_download,
|
live_download=live_download,
|
||||||
download_record=download_record,
|
download_record=download_record,
|
||||||
language=language,
|
language=language,
|
||||||
read_cookie=read_cookie,
|
# read_cookie=read_cookie,
|
||||||
author_archive=author_archive,
|
author_archive=author_archive,
|
||||||
write_mtime=write_mtime,
|
write_mtime=write_mtime,
|
||||||
) as xhs: # 使用自定义参数
|
) as xhs: # 使用自定义参数
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
from xhshow import Xhshow
|
from xhshow import Xhshow
|
||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
from ..module import Manager, retry, sleep_time
|
from ..module import retry, sleep_time
|
||||||
from httpx import get
|
from httpx import get
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
|
|||||||
Reference in New Issue
Block a user