Skip to content

Commit f0a4874

Browse files
timerringtimerring
committed
docs: update zh readme
1 parent 63c9030 commit f0a4874

File tree

2 files changed

+130
-27
lines changed

2 files changed

+130
-27
lines changed

‎README-en.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# biliupload
2+
3+
English | [简体中文](./README.md)
4+
5+
> This is a Python implementation of [biliup-rs](https://github.com/biliup/biliup-rs).
6+
7+
`biliupload` is a command line tool for logining and uploading videos to bilibili, which can also be used as a library for other projects.
8+
9+
## Features
10+
11+
- Save `cookies.json` for bilibili by scanning QR code or web login
12+
- `Upload` videos
13+
- Support uploading videos with yaml config
14+
- `Append` videos to a existing video (WIP)
15+
- `Show` the published videos infomation (planned feature)
16+
- `Download` videos (planned feature)
17+
- `Renew` the cookies (planned feature)
18+
- Show the upload progress (planned feature)
19+
20+
> Over the passed few days, I have implemented the `login` and `upload` functions, and will continue to implement the other functions. Welcome to use and give me more feedback. And welcome to contribute to this project.
21+
22+
## Usage
23+
24+
### Installation
25+
26+
> Recommend Python version >= 3.10.
27+
28+
```bash
29+
pip install biliupload
30+
```
31+
32+
Help information:
33+
34+
```
35+
usage: biliupload [-h] [-V] {login,upload} ...
36+
37+
Python implementation of biliup
38+
39+
positional arguments:
40+
{login,upload} Subcommands
41+
login login and save the cookies
42+
upload upload the video
43+
44+
options:
45+
-h, --help show this help message and exit
46+
-V, --version Print version information
47+
```
48+
49+
### Login
50+
51+
```bash
52+
biliupload login
53+
```
54+
Then you can scan the QR code or click the link to login. The `cookie.json` will be saved in the current directory.
55+
56+
![](https://cdn.jsdelivr.net/gh/timerring/scratchpad2023/2024/2025-01-08-11-54-34.png)
57+
58+
### Upload
59+
60+
Help information:
61+
62+
```bash
63+
$ biliupload upload -h
64+
usage: biliupload upload [-h] -c COOKIES [-y YAML] [--copyright COPYRIGHT] [--title TITLE] [--desc DESC] [--tid TID] [--tags TAGS] [--line LINE] video_path
65+
66+
positional arguments:
67+
video_path (required) the path to video file
68+
69+
options:
70+
-h, --help show this help message and exit
71+
-c COOKIES, --cookies COOKIES
72+
The path to cookies
73+
-y YAML, --yaml YAML The path to yaml file(if yaml file is provided, the arguments below will be ignored)
74+
--copyright COPYRIGHT
75+
(default is 2) 1 for original, 2 for reprint
76+
--title TITLE (default is video name) The title of video
77+
--desc DESC (default is empty) The description of video
78+
--tid TID (default is 138) For more info to the type id, refer to https://biliup.github.io/tid-ref.html
79+
--tags TAGS (default is biliupload) video tags, separated by comma
80+
--line LINE (default is bda2) line refer to https://biliup.github.io/upload-systems-analysis.html
81+
```
82+
83+
Example:
84+
85+
your can refer the [`template/example-config.yaml`](https://github.com/timerring/biliupload/tree/main/template/example-config.yaml) to know more about the yaml template.
86+
87+
```bash
88+
# the video path and cookie path are required
89+
biliupload upload /path/to/your/video.mp4 -c /path/to/your/cookie.json
90+
91+
# upload the video with command line parameters
92+
biliupload upload /path/to/your/video.mp4 -c /path/to/your/cookie.json --title "test" --desc "test" --tid 138 --tags "test" --line bda2
93+
94+
# upload the video with yaml config
95+
biliupload upload /path/to/your/video.mp4 -c /path/to/your/cookie.json -y /path/to/your/upload/template.yaml
96+
```
97+
98+
## Acknowledgments
99+
100+
- Thanks to [bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) for the API collection.
101+
- Thanks to [biliup-rs](https://github.com/biliup/biliup-rs) for the inspiration.

‎README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
11
# biliupload
22

3-
> This is a Python implementation of [biliup-rs](https://github.com/biliup/biliup-rs).
3+
简体中文 | [English](./README-en.md)
44

5-
`biliupload` is a command line tool for logining and uploading videos to bilibili, which can also be used as a library for other projects.
5+
> 这是一个 python 版本实现的 [biliup-rs](https://github.com/biliup/biliup-rs)。
66
7-
## Features
7+
`biliupload` 是一个 python 的命令行工具，用于登录和上传视频到 bilibili，也可以作为其他项目的库使用。
88

9-
- Save `cookies.json` for bilibili by scanning QR code or web login
10-
- `Upload` videos
11-
- Support uploading videos with yaml config
12-
- `Append` videos to a existing video (WIP)
13-
- `Show` the published videos infomation (planned feature)
14-
- `Download` videos (planned feature)
15-
- `Renew` the cookies (planned feature)
16-
- Show the upload progress (planned feature)
9+
## 功能
1710

18-
> Over the passed few days, I have implemented the `login` and `upload` functions, and will continue to implement the other functions. Welcome to use and give me more feedback. And welcome to contribute to this project.
11+
- 保存 `cookies.json` 用于 bilibili 登录
12+
- 上传视频
13+
- 支持上传视频的 yaml 配置
14+
- 追加视频到已有的视频（正在开发）
15+
- 显示已发布的视频信息（预计支持）
16+
- 下载视频（预计支持）
17+
- 更新 cookies（预计支持）
18+
- 显示上传进度（预计支持）
1919

20-
## Usage
20+
> 目前我实现了 `login` 和 `upload` 功能，并会继续实现其他功能。欢迎使用并给我更多反馈。欢迎贡献此项目。
2121
22-
### Installation
22+
## 使用方法
2323

24-
> Recommend Python version >= 3.10.
24+
### 安装
25+
26+
> 推荐 Python 版本 >= 3.10.
2527
2628
```bash
2729
pip install biliupload
2830
```
2931

30-
Help information:
32+
帮助信息：
3133

3234
```
3335
usage: biliupload [-h] [-V] {login,upload} ...
@@ -44,18 +46,18 @@ options:
4446
-V, --version Print version information
4547
```
4648

47-
### Login
49+
### 登录
4850

4951
```bash
5052
biliupload login
5153
```
52-
Then you can scan the QR code or click the link to login. The `cookie.json` will be saved in the current directory.
54+
然后你可以扫描二维码或点击链接登录，`cookie.json` 将保存在当前目录。
5355

5456
![](https://cdn.jsdelivr.net/gh/timerring/scratchpad2023/2024/2025-01-08-11-54-34.png)
5557

56-
### Upload
58+
### 上传
5759

58-
Help information:
60+
`biliupload upload -h ` 打印帮助信息：
5961

6062
```bash
6163
$ biliupload upload -h
@@ -78,22 +80,22 @@ options:
7880
--line LINE (default is bda2) line refer to https://biliup.github.io/upload-systems-analysis.html
7981
```
8082

81-
Example:
83+
示例：
8284

83-
your can refer the [`template/example-config.yaml`](https://github.com/timerring/biliupload/tree/main/template/example-config.yaml) to know more about the yaml template.
85+
你可以参考 [`template/example-config.yaml`](https://github.com/timerring/biliupload/tree/main/template/example-config.yaml) 了解更多的 yaml 模板。
8486

8587
```bash
86-
# the video path and cookie path are required
88+
# 视频路径和 cookie 路径是必需的
8789
biliupload upload /path/to/your/video.mp4 -c /path/to/your/cookie.json
8890

89-
# upload the video with command line parameters
91+
# 使用命令行参数上传视频
9092
biliupload upload /path/to/your/video.mp4 -c /path/to/your/cookie.json --title "test" --desc "test" --tid 138 --tags "test" --line bda2
9193

92-
# upload the video with yaml config
94+
# 使用 yaml 配置上传视频
9395
biliupload upload /path/to/your/video.mp4 -c /path/to/your/cookie.json -y /path/to/your/upload/template.yaml
9496
```
9597

9698
## Acknowledgments
9799

98-
- Thanks to [bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) for the API collection.
99-
- Thanks to [biliup-rs](https://github.com/biliup/biliup-rs) for the inspiration.
100+
- 感谢 [bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect) 提供的 API 集合。
101+
- 感谢 [biliup-rs](https://github.com/biliup/biliup-rs) 提供的灵感。

0 commit comments

Comments
 (0)