CLI wrapper for Reportify SDK - Access Reportify API through command line
Project description
Reportify API CLI
Access all Reportify SDK features via command line.
Features
- Complete coverage of all 8 SDK modules with 44+ methods
- Multiple output formats: JSON, Table, CSV, Markdown
- Simple unified JSON input format with clear help documentation
- AI-friendly design with detailed parameter descriptions
Installation
# Install dependencies and CLI
make install
# Or install directly with uv
uv pip install -e .
Configuration
Set API Key (required):
# Option 1: Environment variable
export REPORTIFY_API_KEY='your-api-key'
# Option 2: .env file
echo "REPORTIFY_API_KEY=your-api-key" > .env
Quick Start
# Show help
reportify-cli --help
reportify-cli -h
# Show module help
reportify-cli docs --help
# Show command help
reportify-cli docs get --help
# Get document details (JSON format)
reportify-cli docs get --input '{"doc_id": "1214713494948155392"}'
# Get stock quote (Table format)
reportify-cli stock quote --input '{"symbol": "600519"}' --format table
# Get financial data (Markdown format)
reportify-cli stock income_statement \
--input '{"symbol": "600519", "period": "annual"}' \
--format markdown
Available Modules
| Module | Description | Commands |
|---|---|---|
search |
Document search | 9 |
docs |
Document management | 4 |
stock |
Stock data | 14 |
timeline |
Timeline | 5 |
kb |
Knowledge base | 1 |
user |
User data | 1 |
quant |
Quantitative analysis | 8 |
concepts |
Concept dynamics | 2 |
Output Formats
4 output formats supported:
--format json- JSON (default)--format table- Table--format csv- CSV--format markdownor--format md- Markdown table
Development
# Show all available commands
make help
# Run tests
make test
# Run unit tests
make test-unit
# Run integration tests (requires API Key)
make test-integration
# Format code
make format
# Lint code
make lint
# Clean cache
make clean
# Reinstall
make reinstall
Project Structure
reportify-cli/
├── src/ # Source code
│ ├── main.py # CLI entry point
│ ├── commands/ # Command modules
│ ├── client.py # SDK client
│ ├── output.py # Output formatting
│ ├── params.py # Parameter definitions
│ ├── settings.py # Configuration
│ └── utils.py # Utilities
├── tests/ # Tests
│ ├── test_commands/ # Unit tests
│ └── integration/ # Integration tests
├── Makefile # Dev commands
├── pyproject.toml # Project config
└── README.md # Documentation
Examples
Search Documents
reportify-cli search query \
--input '{"query": "Tesla earnings", "limit": 10}'
Stock Data
# Company overview
reportify-cli stock overview --input '{"symbol": "600519"}'
# Financial statements
reportify-cli stock income_statement \
--input '{"symbol": "600519", "period": "annual"}'
# Stock prices
reportify-cli stock prices \
--input '{"symbol": "600519", "start_date": "2024-01-01", "end_date": "2024-12-31"}'
Quantitative Analysis
# Compute technical indicators
reportify-cli quant indicators_compute \
--input '{"symbols": ["600519"], "formula": "RSI(14)"}' \
--format table
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
reportify_cli-0.1.29.tar.gz
(64.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reportify_cli-0.1.29.tar.gz.
File metadata
- Download URL: reportify_cli-0.1.29.tar.gz
- Upload date:
- Size: 64.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e84d7add0cb3ae8cf682868325707576bc116de16244fcfc95f6e6e2bf8e6f4f
|
|
| MD5 |
e290a64db234df15d54161fcdcff9b52
|
|
| BLAKE2b-256 |
d5b8523437e0b3396570dd3fca324924437d876c4d53cd331d47b026072e1703
|
File details
Details for the file reportify_cli-0.1.29-py3-none-any.whl.
File metadata
- Download URL: reportify_cli-0.1.29-py3-none-any.whl
- Upload date:
- Size: 24.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
21e2cc6d0c79d6a5846ca2d14be0e0c79f178d55ad927babff8bb049ff2482ce
|
|
| MD5 |
8bedab6d3b3a81ebcc1f0127f7c4754e
|
|
| BLAKE2b-256 |
456601a708b49fdfad34fbb41979c71f8c224f065354cab03eb976952e2d8042
|