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.2.3.tar.gz (81.5 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.2.3-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for telmus-0.2.3.tar.gz
Algorithm Hash digest
SHA256 84b4842836ed5e909dbd829a0c57c263b3ebc8f3691e2d88860ee4ac2c9c6e5d
MD5 8aa4246dbe48810213055df1b28d60f9
BLAKE2b-256 923636843fa3bf1bc4eb8f5b8aabe2289b967fbf2ba30eccec42317e9804c74a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: telmus-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 52.6 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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fa72f0da4ce694f1af8f8db504fe46d13b79c03aaafdf3b6d35d67243b6386fb
MD5 c96d04ed17aea76418188e3a0b08ef11
BLAKE2b-256 f85e9d03a9b555903173771901a5aac6cd6fa993e8ac8ca4aab6146e22d52d76

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