# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2026-01-XX

### Added
- Initial release of SITER Solar Analysis
- Bash-based NREL PVWatts API client (`siter-solar-analysis.sh`)
- JSON and text output formats
- Multiple system size scenario comparison
- Financial analysis with ROI calculations
- Comprehensive BATS test suite (52 tests)
- Docker-based development and test environment
- AGPLv3 license
- Privacy-focused design with data redaction
- API timeout and retry logic with exponential backoff
- Environment variable configuration (NREL_API_KEY, SITER_LAT, SITER_LON)
- Input validation for all parameters
- Shellcheck compliance for all shell scripts

### Security
- Removed CLI API key option (`-k, --api-key`) to prevent process list exposure
- API keys only accepted via environment variable
- Pre-commit hooks to prevent private data commits

### Changed
- Migrated from Python to Bash for production script
- Python scripts marked as deprecated (kept for reference)

### Documentation
- README.md with usage examples and configuration
- CONTRIBUTING.md with development guidelines
- AGENTS.md for AI assistant context
- Code comments and function documentation

## [0.1.0] - 2025-12-XX

### Added
- Initial Python-based NREL PVWatts analysis scripts
- Basic solar production estimation
- Scenario comparison functionality

[1.0.0]: https://github.com/example/siter-solar/compare/v0.1.0...v1.0.0
[0.1.0]: https://github.com/example/siter-solar/releases/tag/v0.1.0