v0.1.21 - Examples Reorganization & Documentation Refresh
Changed
-
Example Configuration Organization
- Migrated example configs from
examples/tosrc/aponyx/examples/configs/for proper PyPI distribution - Renamed to numbered format (01-06) for better organization and discoverability:
01_workflow_minimal.yaml(replacesworkflow_minimal.yaml)02_workflow_complete.yaml(replacesworkflow_complete.yaml)03_workflow_etf_price_backtest.yaml(replacesworkflow_etf.yaml)04_sweep_indicator_lookback.yaml(replacessweep_indicator.yaml)05_sweep_strategy_optimization.yaml(replacessweep_backtest.yaml)06_sweep_comprehensive.yaml(replacessweep_comprehensive.yaml)
- Added comprehensive
src/aponyx/examples/configs/README.mdwith runtime estimates and usage guide - Updated all references across documentation: README, CONTRIBUTING, PROJECT_STATUS, CHANGELOG, CLI guide, all agent/prompt files, and Copilot instructions
- Migrated example configs from
-
Data Fetching Cache Management
- Replaced hash-based cache keys with timestamp-based keys in
fetch.pyfor more intuitive time-based data invalidation - Updated all related tests to use timestamp-based cache validation
- Replaced hash-based cache keys with timestamp-based keys in
Added
- Testing Automation
- New
run-all-examples.prompt.mdfor automated testing of all 6 example configs - Documents actual measured runtimes (~29s total for all examples)
- Supports dry-run and validation modes for CI/CD integration
- New
Improved
- Documentation
- Streamlined README feature list and installation sections (reduced from ~480 to ~387 lines, 19% reduction)
- Updated Python API examples to use Bloomberg/FileSource pattern with tested synthetic data alternatives
- Improved Architecture section with cleaner table formatting
- Updated Research Workflow diagram with actual step class names
- Fixed year references from 2024 to 2025 in README, PROJECT_STATUS, and CHANGELOG
- Removed redundant descriptions throughout documentation
- All code examples tested and verified working