Skip to main content

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 markdown or --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


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.1.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reportify_cli-0.1.1-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file reportify_cli-0.1.1.tar.gz.

File metadata

  • Download URL: reportify_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.5

File hashes

Hashes for reportify_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8fa68a2404371b0a68f9b1991e2b07a39e8f7375258b58738577a7b384e8b597
MD5 d20e6189b3ff2cfee263e611300b0cf4
BLAKE2b-256 037867c5d634de83b3d332ee5d8fc00137df7aad471a8bb9b2a711bc4e48bf31

See more details on using hashes here.

File details

Details for the file reportify_cli-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for reportify_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 86563c287a8b5f5ee1ec7bd8a7ec735bf944298c7970fc44d417a1fb01beb950
MD5 433dfc73e0ff18527caad1af6e2d8598
BLAKE2b-256 c8186e1ba11699d0d82926b85e3ca645fee7626638cb05177120600b9515144b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page