reportify-cli 0.1.0__tar.gz

reportify_cli-0.1.0/.dockerignore

@@ -0,0 +1,4 @@
+.git
+data
+logs
+*.log

reportify_cli-0.1.0/.git

@@ -0,0 +1 @@
+gitdir: ../../.git/modules/modules/cli

reportify_cli-0.1.0/.gitignore

@@ -0,0 +1,133 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.conda/
+example.env
+*.env
+dev.env
+qa.env
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.idea
+.DS_Store
+logs/
+tmp_code_*.py
+*.tmp
+.vscode
+
+.ruff_cache
+
+tmp/
+temp/
+reportify-doc/
+
+# PyPI configuration (contains API tokens)
+.pypirc
+

reportify_cli-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,104 @@
+image: harbor.xiaobangtouzi.com/base/docker:kube-istio-jdk11
+
+stages:
+  - pre_build
+  - build
+  - push_image
+
+variables:
+  DOCKER_DRIVER: overlay2
+
+cache:
+  paths:
+    - .m2/repository
+    - .sonar/cache
+
+build base images:
+  stage: pre_build
+  tags:
+    - arm
+  only:
+    refs:
+      - production@backend/reportify-api-cli
+    changes:
+      - pyproject.toml
+      - uv.lock
+      - Dockerfile.base
+      - pip.conf
+  script:
+    - build_base_image
+
+build image:
+  stage: build
+  when: on_success
+  tags:
+    - arm
+  only:
+    - production@backend/reportify-api-cli
+  script:
+    - build_image
+
+push image to volc:
+  stage: push_image
+  when: manual
+  tags:
+    - arm
+  only:
+    - production@backend/reportify-api-cli
+  script:
+    - push_to_volc
+
+.auto_devops: &auto_devops |
+  # Auto DevOps variables and functions
+  [[ "$TRACE" ]] && set -x
+  export CI_REGISTRY='harbor.xiaobangtouzi.com'
+  export CI_IMAGE_TAG=${CI_COMMIT_SHA:0:10}
+  export VOLC_IMAGE_NAME=harbror-cn-beijing.cr.volces.com/backend/reportify-api-cli:$CI_IMAGE_TAG
+  # TODO rm "reportify-api-cli"
+  export SERVICES=( "reportify-api-cli" )
+
+  function registry_login() {
+    if [[ -n "$CI_REGISTRY_USER" ]]; then
+      echo "Logging to Harbor Registry with CI credentials..."
+      echo "$CI_REGISTRY_PASSWORD" | docker login -u "$CI_REGISTRY_USER" --password-stdin "$CI_REGISTRY"
+    fi
+  }
+
+  function build_base_image() {
+    registry_login
+    echo "Build Python Base Image"
+    image_name=$CI_REGISTRY/base/reportify-api-cli-base-sandbox-$CI_COMMIT_REF_NAME:$CI_IMAGE_TAG
+    image_name_tag=$CI_REGISTRY/base/reportify-api-cli-base-sandbox-$CI_COMMIT_REF_NAME:latest
+    docker build -t ${image_name} -t ${image_name_tag} -f Dockerfile.base .
+    docker push ${image_name}
+    docker push ${image_name_tag}
+    docker rmi ${image_name}
+    docker rmi ${image_name_tag}
+  }
+
+  function build_image() {
+    registry_login
+  
+    BASE_IMAGE=$CI_REGISTRY/base/reportify-api-cli-base-sandbox-$CI_COMMIT_REF_NAME:latest
+    echo "BASE IMAGE $BASE_IMAGE"
+    
+    # build service image
+    for service in "${SERVICES[@]}"
+    do
+      CI_IMAGE_NAME=$CI_REGISTRY/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME/$service/$CI_COMMIT_REF_NAME:$CI_IMAGE_TAG
+      
+      echo "Build $CI_IMAGE_NAME for branch $CI_COMMIT_REF_NAME"
+      echo "CURRENT PATH `pwd`"
+      docker pull $BASE_IMAGE
+      docker build --tag $CI_IMAGE_NAME --tag $VOLC_IMAGE_NAME --build-arg base_image=$BASE_IMAGE -f Dockerfile .
+      docker push $CI_IMAGE_NAME
+      docker rmi $CI_IMAGE_NAME
+    done
+  }
+
+  function push_to_volc() {
+    docker push $VOLC_IMAGE_NAME
+  }
+
+before_script:
+  - *auto_devops

reportify_cli-0.1.0/Dockerfile

@@ -0,0 +1,10 @@
+ARG base_image
+FROM $base_image
+
+WORKDIR /reportify-api-cli
+
+ADD src /reportify-api-cli/src
+
+RUN uv sync
+RUN ln -s /reportify-api-cli/.venv/bin/reportify-api-cli /usr/local/bin/reportify-api-cli
+

reportify_cli-0.1.0/Dockerfile.base

@@ -0,0 +1,10 @@
+FROM harbor.xiaobangtouzi.com/thirdpart/vefaas-public/all-in-one-sandbox:latest AS builder
+
+WORKDIR /reportify-api-cli
+
+ADD pyproject.toml /reportify-api-cli/pyproject.toml
+ADD uv.lock /code/uv.lock
+
+RUN uv sync
+
+RUN pip install --no-cache-dir --upgrade reportify-sdk

reportify_cli-0.1.0/Dockerfile.dev

@@ -0,0 +1,10 @@
+FROM enterprise-public-cn-beijing.cr.volces.com/vefaas-public/all-in-one-sandbox:latest AS builder
+
+WORKDIR /reportify-api-cli
+
+ADD src /reportify-api-cli/src
+ADD pyproject.toml /reportify-api-cli/pyproject.toml
+
+RUN uv sync
+RUN ln -s /reportify-api-cli/.venv/bin/reportify-api-cli /usr/local/bin/reportify-api-cli
+

reportify_cli-0.1.0/Makefile

@@ -0,0 +1,118 @@
+.PHONY: help install dev-install test test-unit test-integration clean lint format run build uninstall reinstall publish-test publish-prod publish-dry-run bump-major bump-minor bump-patch version
+
+# Default target
+help:
+	@echo "Available commands:"
+	@echo ""
+	@echo "Development:"
+	@echo "  make install          - Install the package in editable mode"
+	@echo "  make dev-install      - Install package with dev dependencies"
+	@echo "  make test             - Run all tests"
+	@echo "  make test-unit        - Run unit tests only"
+	@echo "  make test-integration - Run integration tests only"
+	@echo "  make lint             - Run linter (ruff check)"
+	@echo "  make fix              - Fix linter issues automatically"
+	@echo "  make format           - Format code (ruff format)"
+	@echo "  make clean            - Clean up cache and build files"
+	@echo "  make build            - Build the package"
+	@echo "  make reinstall        - Reinstall the package"
+	@echo "  make run              - Run CLI with --help"
+	@echo ""
+	@echo "Publishing:"
+	@echo "  make version          - Show current version"
+	@echo "  make bump-patch       - Bump patch version (0.1.0 -> 0.1.1)"
+	@echo "  make bump-minor       - Bump minor version (0.1.0 -> 0.2.0)"
+	@echo "  make bump-major       - Bump major version (0.1.0 -> 1.0.0)"
+	@echo "  make publish-dry-run  - Dry run of publishing (no actual upload)"
+	@echo "  make publish-test     - Publish to Test PyPI"
+	@echo "  make publish-prod     - Publish to Production PyPI"
+
+# Install package in editable mode
+install:
+	uv sync
+
+# Install with dev dependencies
+dev-install:
+	uv sync --group dev
+
+# Run all tests
+test:
+	uv run pytest tests/ -v
+
+# Run unit tests only
+test-unit:
+	uv run pytest tests/test_commands/ -v
+
+# Run integration tests only (requires REPORTIFY_API_KEY)
+test-integration:
+	uv run pytest tests/integration/ -v
+
+# Run linter
+lint:
+	uv run ruff check src/ tests/
+
+fix:
+	uv run ruff check src/ tests/ --fix
+
+# Format code
+format:
+	uv run ruff format src/ tests/
+
+# Clean cache and build files
+clean:
+	rm -rf __pycache__
+	rm -rf src/__pycache__
+	rm -rf src/commands/__pycache__
+	rm -rf tests/__pycache__
+	rm -rf tests/test_commands/__pycache__
+	rm -rf tests/integration/__pycache__
+	rm -rf .pytest_cache
+	rm -rf .ruff_cache
+	rm -rf build/
+	rm -rf dist/
+	rm -rf *.egg-info
+	rm -rf reportify_api_cli.egg-info
+	find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete
+
+# Build the package
+build:
+	uv build
+
+# Reinstall the package (clean sync)
+reinstall:
+	uv sync --reinstall
+
+# Run CLI with --help
+run:
+	uv run reportify-cli --help
+
+# Show current version
+version:
+	@grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/'
+
+# Bump patch version (0.1.0 -> 0.1.1)
+bump-patch:
+	@./scripts/bump_version.sh patch
+
+# Bump minor version (0.1.0 -> 0.2.0)
+bump-minor:
+	@./scripts/bump_version.sh minor
+
+# Bump major version (0.1.0 -> 1.0.0)
+bump-major:
+	@./scripts/bump_version.sh major
+
+# Dry run of publishing (no actual upload)
+publish-dry-run:
+	@./scripts/publish.sh test dry-run
+
+# Publish to Test PyPI
+publish-test:
+	@./scripts/publish.sh test
+
+# Publish to Production PyPI
+publish-prod:
+	@./scripts/publish.sh prod
+
+

reportify_cli-0.1.0/PKG-INFO

@@ -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
+```
+