Introduces a report file generation feature for GuideLLM and fixes the configuration functionality. Once the frontend is live, we will add the report generation functionality to the CLI and add integration and end to end tests
Details
Report Generation Feature:
Added logic to generate and inject reports from Pydantic models.
Created utility functions for loading HTML templates, injecting data, and saving reports.
Implemented support for both local file paths and URLs as sources for HTML templates.
Included handling for different environments (local, dev, staging, prod) with environment-specific report URLs.
Configuration Improvements:
Refactored configuration structure into a more modular and maintainable format.
Updated configuration to use Pydantic's BaseSettings and model_validator for environment-based settings.
Improved logging configuration with customizable options for console and file logging levels.
Enhanced OpenAI settings for more robust API connectivity.
Testing:
Added comprehensive unit and integration tests for the new report generation feature.
Updated existing tests to align with the new configuration structure.
Ensured all tests pass successfully and that code coverage is maintained.
Test Plan
Automation Testing:
Added and verified unit tests for the report generation and configuration functionalities pass without issues.
Manual Testing:
Manually tested the report generation process using various Pydantic models and HTML templates.
Summary
Introduces a report file generation feature for GuideLLM and fixes the configuration functionality. Once the frontend is live, we will add the report generation functionality to the CLI and add integration and end to end tests
Details
BaseSettings
andmodel_validator
for environment-based settings.Test Plan