Metadata-Version: 2.4
Name: clawshire-cli
Version: 0.1.0a1
Summary: ClawShire CLI for notice query, annual report query, and annual analysis
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: httpx>=0.28.1

# ClawShire CLI

独立可安装的 ClawShire 命令行客户端。

## 安装

```bash
uv tool install clawshire-cli
pipx install clawshire-cli
```

本地开发也可直接从源码目录安装：

```bash
uv tool install ./clawshire-cli
pipx install ./clawshire-cli
```

安装后可使用两个命令入口：

```bash
clawshire --help
cs --help
```

## 命令

主命令分组：

1. `notice`
2. `annual-report`
3. `annual-analysis`

高频简写：

1. `gg` -> `notice`
2. `ar` -> `annual-report`
3. `aa` -> `annual-analysis`

## 示例

```bash
clawshire notice search --start-date 2026-04-01 --end-date 2026-04-20
clawshire annual-report latest --year 2025 --keyword 平安银行
clawshire annual-analysis pdf-file ./report.pdf
clawshire annual-analysis pdf-url https://example.com/report.pdf
clawshire annual-analysis company 000001 --year 2025
```

年报分析测试 PDF 示例：

```text
https://static.cninfo.com.cn/finalpage/2026-04-20/1225116956.PDF
```

## 配置

支持环境变量：

1. `CLAWSHIRE_API_KEY`
2. `CLAWSHIRE_BASE_URL`
3. `CLAWSHIRE_OUTPUT`
4. `CLAWSHIRE_TIMEOUT`

## 发布流程

### 版本更新

1. 修改 [pyproject.toml](/Users/memect/work/code/sz_extract/hermeshub/clawshire-cli/pyproject.toml) 中的 `version`
2. 如有命令变化，同步更新本 README 与根目录 [README.md](/Users/memect/work/code/sz_extract/hermeshub/README.md)

### 本地构建

```bash
cd clawshire-cli
uv build
```

构建产物位于：

```text
clawshire-cli/dist/
```

### 本地安装验证

```bash
cd clawshire-cli
uv tool install .
clawshire --help
cs --help
clawshire notice search --start-date 2026-04-19 --end-date 2026-04-20
```

如果本机已安装 `pipx`，再补一轮：

```bash
cd clawshire-cli
pipx install .
clawshire --help
```

### 发布测试版

建议先发测试版，再发正式版，例如：

1. `0.1.0a1`
2. `0.1.0b1`
3. `0.1.0rc1`

发布命令示例：

```bash
cd clawshire-cli
uv build
uv publish
```

如果要发到 TestPyPI：

```bash
cd clawshire-cli
uv build
uv publish --publish-url https://test.pypi.org/legacy/
```

如果要发到内网 PyPI：

```bash
cd clawshire-cli
uv build
uv publish --publish-url http://192.168.41.95:8141/memect/dev
```

安装验证：

```bash
uv tool install --index memect clawshire-cli
clawshire --help
cs --help
```

### 当前仓库内的限制

当前仓库环境没有可用的公共 PyPI / TestPyPI 发布凭据。  
如果存在内网源可直连且无需额外凭据，则可以直接发布到内网源并验证安装链路。
