Release v1.1.5
This release implements a workaround for a critical issue where PDF report generation would hang indefinitely due to a compatibility issue with Kaleido version >= 0.2.1. The solution ensures PDF reports can be generated reliably, with plots being gracefully omitted and replaced with informative messages.
🔧 Bug Fixes
- Fixed PDF export hanging issue by bypassing Kaleido for static image generation in PDF output
- Added graceful fallback that replaces plots with clear placeholder messages in PDF reports
- Ensured all other report content (statistics, tables, etc.) remains fully functional in PDF output
📝 Documentation Updates
- Added detailed documentation about PDF export limitations in README.md
- Enhanced code comments explaining the Kaleido issue and workaround implementation
- Updated function docstrings to accurately reflect behavior changes
🧪 Test Improvements
- Added comprehensive tests to verify placeholder behavior in PDF exports
- Enhanced test coverage for PDF generation functionality
- Added new test utilities to support verification of report content
🔄 Alternative Options
For users who require plots in PDF exports, we recommend either:
- Using HTML export format (default) which provides fully interactive visualizations
- Using pytics version 1.1.3 which supports PDF plots but requires Kaleido < 0.2.1
📋 Technical Details
- Issue: Kaleido >= 0.2.1 causes PDF export to hang indefinitely when converting Plotly figures
- Workaround: Skip static image generation for PDF format, return 'PLOT_OMITTED_FOR_PDF' placeholder
- Impact: Affects only PDF export; HTML reports retain full functionality with interactive plots
🔍 Breaking Changes
None. All existing functionality remains intact, with PDF export being modified to handle plots gracefully rather than hanging.
🐛 Known Issues
- PDF reports will not include plots (by design, to prevent hanging)
- All other report content and functionality remains unaffected