Metadata-Version: 2.4
Name: agent-stock
Version: 0.1.5
Summary: A fast CLI tool for real-time stock data
Project-URL: Homepage, https://github.com/AnoyiX/agent-stock
Project-URL: Repository, https://github.com/AnoyiX/agent-stock
Project-URL: Issues, https://github.com/AnoyiX/agent-stock/issues
Author-email: AnoyiX <anoyi@qq.com>
License-Expression: Apache-2.0
Keywords: cli,stock
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: click>=8.0
Requires-Dist: requests>=2.32.0
Provides-Extra: dev
Requires-Dist: mypy>=1.15.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.11.0; extra == 'dev'
Requires-Dist: types-requests>=2.32.0; extra == 'dev'
Description-Content-Type: text/markdown

# agent-stock

[![CI](https://github.com/AnoyiX/agent-stock/actions/workflows/ci.yml/badge.svg)](https://github.com/AnoyiX/agent-stock/actions/workflows/ci.yml)
[![PyPI version](https://img.shields.io/pypi/v/agent-stock.svg)](https://pypi.org/project/agent-stock/)
[![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue.svg)](https://pypi.org/project/agent-stock/)

面向 AI Agent 的股市数据命令行工具，提供市场概览、个股行情、板块涨跌、技术指标与资金流向等信息。

## 安装

```bash
# pipx
pipx install agent-stock  # 安装
pipx upgrade agent-stock  # 升级

# uv tool
uv tool install agent-stock  # 安装
uv tool upgrade agent-stock  # 升级

# pip
python -m pip install agent-stock     # 安装
python -m pip install -U agent-stock  # 升级
```

## 快速开始

```bash
# 市场数据
stock search 腾讯
stock chgdiagram --market ab
stock heatmap --market ab
stock rank --count 20

# 个股数据
stock quote 000001
stock quote 000001,600519
stock kline 000001
stock fundflow 000001

# 帮助与版本
stock --help
stock quote --help
stock -v
```

## 命令

可以通过 `stock --help` 或 `stock <子命令> --help` 查看帮助。

### 市场数据

```bash
stock index --market <market>             # 大盘主要指数总览
stock chgdiagram --market <market>        # 涨跌分布
stock heatmap --market <market>           # 行业板块热力图
stock search <keyword>                    # 股票搜索
stock query <condition>                   # 条件选股
stock rank --sort <sort> --count <count>  # 市场排序（仅 A 股）
```

参数说明：
- market: 市场，可选 ab｜us｜hk，默认 ab
- sort: 排序类型，可选 turnover｜amplitude｜volumeRatio｜exchange｜priceRatio，默认 turnover
- count: 排序数量，默认 20，取值范围 1 - 100
- keyword: 关键词，示例：腾讯、tengxun等
- condition: 自然语言的条件语句，示例："MACD金叉；KDJ金叉；非ST；非涨停；市盈率大于0；市盈率小于100；市值大于50亿；"

### 个股数据

```bash
stock quote <symbols>               # 个股实时行情（支持批量查询）
stock plate <symbol>                # 个股相关板块涨跌幅（地域/行业/概念）
stock news <symbol>                 # 个股最新资讯
stock kline <symbol>                # 日K数据以及技术指标（EMA/BOLL/KDJ/RSI）
stock fundflow <symbol>             # 资金分布与每日主力/散户净流向
```

参数说明：
- symbol: 股票代码，支持 A 股、港股、美股
  - A股：6 位数字，如 600519、000001
  - 港股：5 位数字，如 00700
  - 美股：us.<ticker>，如 us.aapl、us.msft（大小写不敏感）
- symbols: 单个或多个股票代码，用逗号分隔，如 000001,00700,us.aapl


## 开发

```bash
# 安装依赖
uv sync

# 运行测试
uv run pytest tests/ -v

# Lint
uv run ruff check .

# 安装当前目录源码，并暴露 `stock` 命令
uv tool install --from . agent-stock

# 强制升级
uv tool install --from . agent-stock --force --reinstall --refresh --no-cache

# 卸载
uv tool uninstall agent-stock

# 调试
uv run python -m stock quote 000001
```

## License

Apache-2.0
