Metadata-Version: 2.1
Name: byrdocs_cli
Version: 0.5.2
Summary: A simple command line tool for BYR Docs
Home-page: https://github.com/byrdocs/byrdocs-cli
Author: Rikka
Author-email: Rikka <rikka@byrdocs.org>
License: MIT License
Project-URL: Homepage, https://github.com/byrdocs/byrdocs-cli
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.1
Requires-Dist: boto3==1.35.62
Requires-Dist: botocore==1.35.62
Requires-Dist: argcomplete==3.5.1
Requires-Dist: tqdm==4.67.0
Requires-Dist: InquirerPy==0.3.4
Requires-Dist: pyyaml==6.0.2
Requires-Dist: isbnlib==3.10.14
Requires-Dist: pinyin==0.4.0

# BYR Docs CLI

## 安装

### 使用 `pip` 安装：
```bash
pip3 install byrdocs-cli
```

### 使用 `pipx` 安装（当 `pip` 无法使用时）：

根据包管理器选择对应的命令安装 `pipx`：
```bash
sudo apt install pipx
sudo dnf install pipx
sudo pacman -S pipx
```

再使用 `pipx` 进行安装：
```
pipx install byrdocs-cli   
```

### 更新

使用 `pip`:
```bash
pip install byrdocs-cli --upgrade 
```

使用 `pipx`:
```bash
pipx upgrade byrdocs-cli
```

## 使用

```
用法: 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
```

## 开发

构建:

```bash
python3 -m build
```


发布到 PyPI:
```bash
python3 -m twine upload --repository pypi dist/* --verbose
```

测试:
```bash
python test.py [arguments]
```
