reportify-cli 0.1.0__py3-none-any.whl

reportify_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: reportify-cli
+Version: 0.1.0
+Summary: CLI wrapper for Reportify SDK - Access Reportify API through command line
+Project-URL: Homepage, https://reportify.ai
+Project-URL: Documentation, https://docs.reportify.ai
+Project-URL: Repository, https://github.com/reportify/reportify-cli
+Project-URL: Issues, https://github.com/reportify/reportify-cli/issues
+Author-email: Reportify Team <support@reportify.ai>
+License: MIT
+Keywords: api,cli,finance,reportify,research,stock
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: reportify-sdk>=0.3.9
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: typer>=0.21.1
+Description-Content-Type: text/markdown
+
+# Reportify API CLI
+
+通过命令行访问 [Reportify SDK](https://github.com/reportify-ai/reportify-doc/tree/main/sdks) 的所有功能。
+
+## 特性
+
+- 🚀 **完整功能** - 支持 Reportify SDK 的所有 8 个模块、44+ 个方法
+- 📊 **多种输出格式** - JSON、Table、CSV、Markdown
+- 🎯 **简单易用** - 统一的 JSON 输入格式，清晰的帮助文档
+- 🤖 **AI 友好** - 专为 AI Agent 设计，提供详细的参数说明
+
+## 安装
+
+```bash
+# 安装依赖并安装 CLI
+make install
+
+# 或使用 uv 直接安装
+uv pip install -e .
+```
+
+## 配置
+
+设置 API Key（必需）：
+
+```bash
+# 方式 1: 环境变量
+export REPORTIFY_API_KEY='your-api-key'
+
+# 方式 2: .env 文件
+echo "REPORTIFY_API_KEY=your-api-key" > .env
+```
+
+## 快速开始
+
+```bash
+# 查看帮助
+reportify-cli --help
+reportify-cli -h
+
+# 查看模块帮助
+reportify-cli docs --help
+
+# 查看命令帮助
+reportify-cli docs get --help
+
+# 获取文档详情（JSON 格式）
+reportify-cli docs get --input '{"doc_id": "1214713494948155392"}'
+
+# 获取股票行情（Table 格式）
+reportify-cli stock quote --input '{"symbol": "600519"}' --format table
+
+# 获取财务数据（Markdown 格式）
+reportify-cli stock income_statement \
+  --input '{"symbol": "600519", "period": "annual"}' \
+  --format markdown
+```
+
+## 可用模块
+
+| 模块 | 说明 | 命令数 |
+|------|------|--------|
+| `search` | 文档搜索功能 | 9 |
+| `docs` | 文档内容功能 | 4 |
+| `stock` | 股票数据功能 | 14 |
+| `timeline` | 时间线功能 | 5 |
+| `kb` | 知识库功能 | 1 |
+| `user` | 用户数据功能 | 1 |
+| `quant` | 量化分析功能 | 8 |
+| `concepts` | 概念动态功能 | 2 |
+
+## 输出格式
+
+支持 4 种输出格式：
+
+- `--format json` - JSON 格式（默认）
+- `--format table` - 表格格式
+- `--format csv` - CSV 格式
+- `--format markdown` 或 `--format md` - Markdown 表格
+
+## 开发
+
+```bash
+# 查看所有可用命令
+make help
+
+# 运行测试
+make test
+
+# 运行单元测试
+make test-unit
+
+# 运行集成测试（需要 API Key）
+make test-integration
+
+# 代码格式化
+make format
+
+# 代码检查
+make lint
+
+# 清理缓存
+make clean
+
+# 重新安装
+make reinstall
+```
+
+## 项目结构
+
+```
+reportify-cli/
+├── src/                    # 源代码
+│   ├── main.py            # CLI 入口
+│   ├── commands/          # 命令模块
+│   ├── client.py          # SDK 客户端
+│   ├── output.py          # 输出格式化
+│   ├── params.py          # 参数定义
+│   ├── settings.py        # 配置管理
+│   └── utils.py           # 工具函数
+├── tests/                 # 测试
+│   ├── test_commands/     # 单元测试
+│   └── integration/       # 集成测试
+├── Makefile              # 开发命令
+├── pyproject.toml        # 项目配置
+└── README.md             # 项目文档
+```
+
+## 示例
+
+### 搜索文档
+
+```bash
+reportify-cli search query \
+  --input '{"query": "茅台", "limit": 10}'
+```
+
+### 获取股票数据
+
+```bash
+# 公司概览
+reportify-cli stock overview --input '{"symbol": "600519"}'
+
+# 财务报表
+reportify-cli stock income_statement \
+  --input '{"symbol": "600519", "period": "annual"}'
+
+# 股价数据
+reportify-cli stock prices \
+  --input '{"symbol": "600519", "start_date": "2024-01-01", "end_date": "2024-12-31"}'
+```
+
+### 量化分析
+
+```bash
+# 计算技术指标
+reportify-cli quant indicators_compute \
+  --input '{"symbols": ["600519"], "formula": "RSI(14)"}' \
+  --format table
+```
+

reportify_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+src/__init__.py,sha256=pCgfSCOZC0IS1fpgeWNlXmeOx7g1s4DJpFO0042VpKg,91
+src/client.py,sha256=wVWC9-YCXIPai8oYVbJ54DSDgIq0X72z_DG155fIqW4,412
+src/main.py,sha256=kxnYa0xAKZ_5jY8QhkrSkvmZvKP1xP4moNDNgRcoCl8,1378
+src/output.py,sha256=kk2cQiwZqga7zaIY71fphCDfebrbpwfOM90j9N8qZeo,2536
+src/params.py,sha256=NI13XETknGPqZPN6RXq_ZFZhXp8AG-RMqDMW4F3vbII,18786
+src/settings.py,sha256=TsUQnLBF_ipAN-N5xOssVtFB7OVBUe3ehL5tKEgio9Q,743
+src/utils.py,sha256=Z2ZumPlyd7pPZd7shY-TbcInSWRyO6M9adYgtKngCfU,1743
+src/commands/__init__.py,sha256=PhcPqytvX5igY92nG1DKwkrTV057Sfa44pHObuzojNU,45
+src/commands/channels.py,sha256=ePw2uGzmV3UioVNXAaRlIyfhspDppZPMBI7aXBa9QUc,4284
+src/commands/concepts.py,sha256=xIEOVvjAqg8lgvSW6FebG6JCftMzt1owOg3B6Ac3uYw,1643
+src/commands/docs.py,sha256=FqnB_SiITYXWPhVTsNcnf9tjusWmvefxoh8NMDZ0_Xc,11716
+src/commands/kb.py,sha256=ik4qCiafMwauOjwnztQvK0f8_WKjZXkkx0ZeHKrioCg,1143
+src/commands/quant.py,sha256=ghDmg6fON1pRuPJesxmZrzQ-jNAslaokoU4aioDtNsQ,6247
+src/commands/search.py,sha256=ono_eMX60qj5JjjSZezRPUgm8Ff4uP4rapbqaNiWV48,7471
+src/commands/stock.py,sha256=vsQgqNkzQLTp0pBj6i049Cjme16Nq2ro8GNRGHigyZc,10257
+src/commands/timeline.py,sha256=wL3eRUyPietO91b6f5Mtxxh8rxAqyMdkeNTROXSuvQQ,3824
+src/commands/user.py,sha256=N68wEwHija6W9bpQAnk9Sun828Ymo22iye8lTmFEe00,1002
+reportify_cli-0.1.0.dist-info/METADATA,sha256=SVwHmKqh0tZ3VW8pOkJRId2W3scmxKzJTDA6ryrdi9E,4838
+reportify_cli-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+reportify_cli-0.1.0.dist-info/entry_points.txt,sha256=rw43LXWM0I2Zm2VgSUfBhK3awAeque97wNw-Mw0BvDQ,47
+reportify_cli-0.1.0.dist-info/RECORD,,

reportify_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

reportify_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+reportify-cli = src.main:app

src/__init__.py

@@ -0,0 +1,3 @@
+"""Reportify API CLI - Command line interface for Reportify SDK."""
+
+__version__ = "0.1.0"

src/client.py

@@ -0,0 +1,20 @@
+"""Reportify SDK client wrapper."""
+
+from reportify_sdk import Reportify
+
+from src.settings import get_api_key
+
+_client = None
+
+
+def get_client() -> Reportify:
+    """Get or create Reportify SDK client instance.
+
+    Returns:
+        Reportify: SDK client instance
+    """
+    global _client
+    if _client is None:
+        api_key = get_api_key()
+        _client = Reportify(api_key=api_key)
+    return _client

src/commands/__init__.py

@@ -0,0 +1 @@
+"""Command modules for Reportify API CLI."""

src/commands/channels.py

@@ -0,0 +1,137 @@
+"""Channels module commands."""
+
+from typing import Annotated
+
+import typer
+
+from src import params
+from src.client import get_client
+from src.output import format_output
+from src.utils import generate_epilog, parse_json_input
+
+app = typer.Typer(help="频道管理功能", rich_markup_mode="rich")
+
+
+@app.command(
+    epilog=generate_epilog(
+        params.CHANNELS_SEARCH_PARAMS,
+        [
+            'reportify-cli channels search --input \'{"query": "Goldman Sachs"}\'',
+            'reportify-cli channels search --input \'{"query": "财经", "page_size": 20}\'',
+        ],
+    )
+)
+def search(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """搜索频道"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        result = client.channels.search(**params_dict)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)
+
+
+@app.command(
+    epilog=generate_epilog(
+        params.CHANNELS_FOLLOWINGS_PARAMS,
+        [
+            "reportify-cli channels followings",
+            'reportify-cli channels followings --input \'{"page_size": 20}\'',
+        ],
+    )
+)
+def followings(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """获取关注的频道列表"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        result = client.channels.followings(**params_dict)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)
+
+
+@app.command(
+    epilog=generate_epilog(
+        params.CHANNELS_FOLLOW_PARAMS,
+        [
+            'reportify-cli channels follow --input \'{"channel_id": "channel_123"}\'',
+        ],
+    )
+)
+def follow(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """关注频道"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        channel_id = params_dict.get("channel_id")
+        if not channel_id:
+            raise ValueError("channel_id is required")
+        result = client.channels.follow(channel_id)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)
+
+
+@app.command(
+    epilog=generate_epilog(
+        params.CHANNELS_UNFOLLOW_PARAMS,
+        [
+            'reportify-cli channels unfollow --input \'{"channel_id": "channel_123"}\'',
+        ],
+    )
+)
+def unfollow(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """取消关注频道"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        channel_id = params_dict.get("channel_id")
+        if not channel_id:
+            raise ValueError("channel_id is required")
+        result = client.channels.unfollow(channel_id)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)
+
+
+@app.command(
+    name="get_docs",
+    epilog=generate_epilog(
+        params.CHANNELS_GET_DOCS_PARAMS,
+        [
+            "reportify-cli channels get_docs",
+            'reportify-cli channels get_docs --input \'{"channel_ids": "channel_1,channel_2", "page_size": 20}\'',
+        ],
+    ),
+)
+def get_docs(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """获取关注频道的文档"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        result = client.channels.get_docs(**params_dict)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)

src/commands/concepts.py

@@ -0,0 +1,54 @@
+"""Concepts module commands."""
+
+from typing import Annotated
+
+import typer
+
+from src import params
+from src.client import get_client
+from src.output import format_output
+from src.utils import generate_epilog, parse_json_input
+
+app = typer.Typer(help="概念动态功能", rich_markup_mode="rich")
+
+
+@app.command(
+    epilog=generate_epilog(
+        params.CONCEPTS_LATEST_PARAMS,
+        [
+            "reportify-cli concepts latest",
+            "reportify-cli concepts latest --input '{\"include_docs\": false}'",
+        ],
+    )
+)
+def latest(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """获取最新概念列表"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        result = client.concepts.latest(**params_dict)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)
+
+
+@app.command(
+    epilog=generate_epilog(params.CONCEPTS_TODAY_PARAMS, ["reportify-cli concepts today"])
+)
+def today(
+    input: Annotated[str, typer.Option(help="JSON 格式的输入参数")] = "{}",
+    format: Annotated[str, typer.Option(help="输出格式: json, table, csv")] = "json",
+):
+    """获取今日概念动态"""
+    try:
+        params_dict = parse_json_input(input)
+        client = get_client()
+        result = client.concepts.today(**params_dict)
+        format_output(result, format)
+    except Exception as e:
+        typer.echo(f"Error: {e}", err=True)
+        raise typer.Exit(1)