A simple command line tool for BYR Docs
Project description
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]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file byrdocs_cli-0.5.8.tar.gz.
File metadata
- Download URL: byrdocs_cli-0.5.8.tar.gz
- Upload date:
- Size: 16.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02bc0a82a6b9995a2e51f70ccdebfdbdcfa5826261164af3a5860be3e912d4be
|
|
| MD5 |
216e306aa02aaa94aabf229f16ad5381
|
|
| BLAKE2b-256 |
b427ba6e467d171c516f695c0d38ce83ffb8aaa181b03eec2358665ea7d6b2c7
|
Provenance
The following attestation bundles were made for byrdocs_cli-0.5.8.tar.gz:
Publisher:
python-publish.yml on byrdocs/byrdocs-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
byrdocs_cli-0.5.8.tar.gz -
Subject digest:
02bc0a82a6b9995a2e51f70ccdebfdbdcfa5826261164af3a5860be3e912d4be - Sigstore transparency entry: 245648867
- Sigstore integration time:
-
Permalink:
byrdocs/byrdocs-cli@f7af227c1a3b5ea088ca1935336bce3cf4d76bad -
Branch / Tag:
refs/tags/v0.5.8 - Owner: https://github.com/byrdocs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@f7af227c1a3b5ea088ca1935336bce3cf4d76bad -
Trigger Event:
release
-
Statement type:
File details
Details for the file byrdocs_cli-0.5.8-py3-none-any.whl.
File metadata
- Download URL: byrdocs_cli-0.5.8-py3-none-any.whl
- Upload date:
- Size: 17.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bb8861706d4d8a2d16e5063e9525e609b6efe9e98f7193b2390545fdb4eb70e
|
|
| MD5 |
a91239c84d51a6d224025591b172fab1
|
|
| BLAKE2b-256 |
a79da23c87a7be809d4b6e639735ec00c4bb7b54c7efb6b28cfe8c1c89712187
|
Provenance
The following attestation bundles were made for byrdocs_cli-0.5.8-py3-none-any.whl:
Publisher:
python-publish.yml on byrdocs/byrdocs-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
byrdocs_cli-0.5.8-py3-none-any.whl -
Subject digest:
8bb8861706d4d8a2d16e5063e9525e609b6efe9e98f7193b2390545fdb4eb70e - Sigstore transparency entry: 245648868
- Sigstore integration time:
-
Permalink:
byrdocs/byrdocs-cli@f7af227c1a3b5ea088ca1935336bce3cf4d76bad -
Branch / Tag:
refs/tags/v0.5.8 - Owner: https://github.com/byrdocs
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@f7af227c1a3b5ea088ca1935336bce3cf4d76bad -
Trigger Event:
release
-
Statement type: