Skip to main content

Financial statement analysis for AI IDEs and coding agents

Project description

telmus

PyPI version Downloads Python License

Financial statement analysis for AI IDEs and coding agents.

pip install telmus
telmus scan INFY

What is telmus?

telmus is a Python package and CLI for parsing financial statements, computing key valuation and health ratios, and exposing them through an MCP server for AI tools.

Engines

Engine What it measures Key metric
Valuation Price multiples and peer comparison P/E, P/B, EV/EBITDA
Health Balance sheet strength and bankruptcy risk Piotroski F-score, Altman Z-score
Flags Earnings quality and cash flow risk Beneish M-score, free cash flow trend

analyst_brief

A deterministic summary field that explains fundamentals, growth, and red flags without using an LLM.

Example output:

{
  "analyst_brief": "Strong fundamentals (Piotroski F-score of 7). Financially safe (Altman Z-score of 4.20). Revenue growth is 11.2% over three years and operating margins are stable. No significant red flags detected. Suitable for DCF or comparable company analysis."
}

Quick start

  1. Install:
pip install telmus
  1. Scan a ticker:
telmus scan INFY
  1. Read the summary and analyst brief, or export JSON for automation.

MCP server setup

{
  "mcpServers": {
    "telmus": {
      "command": "telmus",
      "args": ["serve"],
      "description": "Financial statement analysis — real ratios for any ticker"
    }
  }
}
  • Claude Desktop: use the config to register telmus as an MCP tool.
  • Cursor: same config loads telmus as a tool for market research.
  • Windsurf: connect the MCP server to get real financial metrics.

Other commands

Command Description
telmus scan TICKER Run a full financial scan
telmus scan TICKER --json Print raw JSON
telmus scan TICKER --export FILE.json Save JSON to a file
telmus compare A B Compare two tickers
telmus screen Run a simple sector screener
telmus serve Start the MCP server
telmus info Print package info
telmus check TICKER Quick health check

Benchmark

Test Result
Piotroski score coverage 9 signals
Altman Z distress detection safe/grey/distress ranges
Flag detection Beneish M, D/E, FCF trend

Architecture

yfinance -> loader -> valuation/health/growth/flags -> ScanResult -> CLI / MCP / SDK

Contributing

  1. Fork the repository.
  2. Create a feature branch.
  3. Run pip install -e ."[dev]".
  4. Write tests and update docs.
  5. Submit a pull request.

License

MIT License

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

telmus-0.1.13.tar.gz (72.6 kB view details)

Uploaded Source

Built Distribution

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

telmus-0.1.13-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file telmus-0.1.13.tar.gz.

File metadata

  • Download URL: telmus-0.1.13.tar.gz
  • Upload date:
  • Size: 72.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for telmus-0.1.13.tar.gz
Algorithm Hash digest
SHA256 b3bc21c11bde44eda33f8aabd0d6a977a41e4924780bec5298831a34634cc11b
MD5 460a6308e43beba19964867a2f380fc2
BLAKE2b-256 0828398d22f0ffe11ce5c58660de6f7690442d5a21cf2f476bacc551d7cea988

See more details on using hashes here.

File details

Details for the file telmus-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: telmus-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for telmus-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 d3b5f012c21ea763c48f522f7c58a37c31b95bb127eec9c46f0e36c4e9d77a10
MD5 a506920c72e7b2c0ccdf5b5b325175cd
BLAKE2b-256 3a373523d85efbb0a0ccfb8283635becb1a6ee5ebaffd7c889f90c787d336074

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