Developer Guide

Developer Guide

Repository layout

• src/cli.py: Click-based CLI entry point
• src/indicators.py: data fetch, indicator calculations, output writing
• src/default_configs.json: default indicator window sizes by period/timeframe
• tests/: correctness + integration + format + batch tests
• profiling/: profiling runner scripts and results format

Local development

Editable install:

pip install -e .

Run the CLI:

indicators AAPL

Tests

Run all tests:

indicators --test

Run one suite:

indicators --test --test-suite correctness

Test suites:

• correctness: per-indicator validation
• integration: end-to-end runs
• formats: writer/reader validation across formats
• batch: multi-ticker behavior

Release process

The project is published via GitHub Actions when a tag starting with v is pushed (see README.md for details).

Docs maintenance

The GitHub Wiki lives in a separate repository. Keep it in sync when you change behavior:

• If you change CLI flags/options: update CLI Reference
• If you change config keys/defaults: update Configuration & Templates
• If you add/change indicator columns: update Indicators (Overview) and the relevant indicator page
• If you change test/profiling commands: update Profiling

Related pages:

• CLI Reference
• Profiling