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.22.tar.gz (63.4 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.22-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reportify_cli-0.1.22.tar.gz
  • Upload date:
  • Size: 63.4 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.22.tar.gz
Algorithm Hash digest
SHA256 3fd170f2c02e9cfbdbc554d784f9b0ea6f704abb268b622c37bc1acb8e7a1145
MD5 1bdc682b6bfd035b060aefc80b1f289d
BLAKE2b-256 d9c3af7a30838329b36dd87569265260eb29c150a0de4668421761355381413d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: reportify_cli-0.1.22-py3-none-any.whl
  • Upload date:
  • Size: 24.5 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 ae7267b3645f7f89d7f58990cf5eef4c36c7a97af1b837e6748c37da8e19a829
MD5 86cec888be8fe26343684f56423d047d
BLAKE2b-256 0aaccbc837c51585a5ae2e2578360cfc2d631beb925a52b9c5a7f0b8ba6d1ea5

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