Metadata-Version: 2.1
Name: byrdocs_cli
Version: 0.4.3
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==5.3.1
Requires-Dist: isbnlib==3.10.14
Requires-Dist: pinyin==0.4.0

# BYR Docs CLI

## Install 

### Using pip:
```bash
pip3 install byrdocs-cli
```

### Using pipx (alternated, when you have problem with pip):

Choose one of the following commands according to your package manager:
```bash
sudo apt install pipx
sudo dnf install pipx
sudo pacman -S pipx
```

Then:
```
pipx install byrdocs-cli    
```

## Usage

```
usage: byrdocs [-h] [--token TOKEN] [command] [file]

Commands:
  upload <file>    Upload a file. If no command is specified, it defaults to upload.
  login            Authenticate with BYR Docs and obtain a token.
  logout           Remove the locally stored authentication token.
  init             交互式地生成文件元信息 yaml 文件
  validate         (施工中) 判断 yaml 元信息文件的合法性

positional arguments:
  command        Command to execute
  file           Path to the file to upload

options:
  -h, --help     show this help message and exit
  --token TOKEN  Token for login command

Examples:
 $ byrdocs login
 $ byrdocs /home/exam_paper.pdf
 $ byrdocs logout
 $ byrdocs init
```

## Development

Build:

```bash
python3 -m build
```


Push to PyPI:
```bash
python3 -m twine upload --repository pypi dist/* --verbose
```

Test:
```bash
python test.py [arguments]
```
