BYR Docs CLI
安装
使用 pip 安装：
pip3 install byrdocs-cli
使用 pipx 安装（当 pip 无法使用时）：
根据包管理器选择对应的命令安装 pipx：
pip install pipx
sudo apt install pipx
sudo dnf install pipx
sudo pacman -S pipx
再使用 pipx 进行安装：
pipx install byrdocs-cli
使用 homebrew 安装（MacOS 或 Linux）：
brew tap byrdocs/homebrew-byrdocs-cli
brew install byrdocs-cli
更新
使用 pip:
pip install --upgrade byrdocs-cli
使用 pipx:
pipx upgrade byrdocs-cli
使用 homebrew:
brew upgrade byrdocs-cli
使用
直接在命令行中输入命令 byrdocs，打开交互式页面，或填写命令参数调用：
用法: byrdocs [-h] [--token TOKEN] [command] [file]
命令：
upload <文件路径> 上传文件 [默认命令]
login 登录到 BYR Docs
logout 退出登录
init 交互式生成文件元信息文件
validate (待实现) 验证元信息文件的合法性
参数:
command 要执行的命令
file 要上传的文件路径
选项:
-h, --help 输出该帮助信息并退出
--token TOKEN 指定登录时使用的 token
示例：
$ byrdocs login
$ byrdocs /home/exam_paper.pdf
$ byrdocs logout
$ byrdocs init
开发
构建:
python3 -m build
发布到 PyPI:
python3 -m twine upload --repository pypi dist/* --verbose
测试:
python test.py [arguments]
1 maintainer
Metadata
1 maintainer
Release files for byrdocs-cli 0.5.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| byrdocs_cli-0.5.8.tar.gz | 16.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| byrdocs_cli-0.5.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.1 kB
Release files / byrdocs_cli-0.5.8.tar.gz
| Download URL | byrdocs_cli-0.5.8.tar.gz |
|---|---|
| Size | 16.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
02bc0a82a6b9995a2e51f70ccdebfdbdcfa5826261164af3a5860be3e912d4be
|
|
BLAKE2b-256 checksum How to use checksums |
b427ba6e467d171c516f695c0d38ce83ffb8aaa181b03eec2358665ea7d6b2c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 21, 2025.
Transparency logRelease files / byrdocs_cli-0.5.8-py3-none-any.whl
| Download URL | byrdocs_cli-0.5.8-py3-none-any.whl |
|---|---|
| Size | 17.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8bb8861706d4d8a2d16e5063e9525e609b6efe9e98f7193b2390545fdb4eb70e
|
|
BLAKE2b-256 checksum How to use checksums |
a79da23c87a7be809d4b6e639735ec00c4bb7b54c7efb6b28cfe8c1c89712187
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 21, 2025.
Transparency log
