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.15.tar.gz (58.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.15-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reportify_cli-0.1.15.tar.gz
  • Upload date:
  • Size: 58.6 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

Hashes for reportify_cli-0.1.15.tar.gz
Algorithm Hash digest
SHA256 d18a087e94c04859e3f949e044bdfc67867a05f4eb9325c06a162aff5c4976a9
MD5 2fad2bc3e38bbe71f365f3ccd8616a7c
BLAKE2b-256 8079b0a5f1b5c084f445ba4ea7bd5418d615e8dd06ca47d9ebac10d2ea8fc40a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: reportify_cli-0.1.15-py3-none-any.whl
  • Upload date:
  • Size: 24.4 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

Hashes for reportify_cli-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 fe0b0f7ab529b4c6d71a4d26720faf2561ad54049f7188a9be808acf2b44a0b2
MD5 0c5d2196fc7b8e0b886d1737da212701
BLAKE2b-256 7a4d081093deebb6afcbc676a61c501be4bae853c4096b2c58cd101613d5848c

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