rmToo 26.0.2

rmToo 26.0.2 Release Notes

Release Date: 2025-07-16

No changes

Because of a problem with pypi there is the need to bump up the version number.
No changes, same content as version 26.0.1.

rmToo 26.0.1 Release Notes

Release Date: 2025-07-15

🐛 Bug Fixes

Documentation Improvements

• Complete documentation reorganization: Restructured all documentation into a clean docs/ directory structure
• Enhanced documentation quality: Improved content quality and removed all broken links
• New structured guides: Added comprehensive user guides, developer guides, and installation instructions
• FAQ consolidation: Moved and improved FAQ content for better accessibility
• Link validation: Added automated link checking to prevent future broken links

Package and Installation Fixes

• Fixed rmtoo-contrib-dir command: Now works correctly with PyPI installations
• Fixed YAML package inclusion: YAML support now properly included in PyPI packages
• Template project updates: Updated all template projects to use the new rmtoo-contrib-dir command

Code Quality Improvements

• Statistics module robustness: Fixed crashes when insufficient data available for statistical analysis
• LaTeX output escaping: Fixed HTML entity escaping issues in LaTeX output
• Enhanced logging system: Added --verbose and --logfile options for better debugging
• Configurable log levels: New --log-level switch allows fine-tuning of log output

Development Cleanup

• Eclipse cleanup: Removed obsolete Eclipse IDE configuration files
• Package configuration: Enhanced setup.py with better PyPI package support
• Build improvements: Updated build scripts to use modern commands

rmToo 26.0.1

Removed accidentially commit old release

Signed-off-by: Andreas Florath <Andreas.Florath@telekom.de>

rmToo 26.0.0

This release represents over 4 years of continuous development and modernization efforts since rmToo 25.0.0 (August 2020). The focus has been on improving usability, expanding platform support, enhancing security, and modernizing the development infrastructure.

🎉 Major New Features

New rmtoo-contrib-dir Command

• New command: rmtoo-contrib-dir provides reliable access to contrib directory
• Cross-platform: Works consistently across pip, system packages, and development installs
• Template project access: cp -r "$(rmtoo-contrib-dir)/template_project" MyProject
• Replaces manual path finding: No more hunting for contrib files after installation

YAML File Format Support

• YAML storage backend: Full support for YAML format in requirements and topics
• Simplified configuration: YAML provides cleaner, more readable configuration files
• Backwards compatible: Existing text-based files continue to work

🐍 Python Support Updates

Expanded Python Version Support

• Added support for: Python 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
• Modernized codebase: Removed Python 2 compatibility layers
• Removed legacy dependencies: Eliminated six and future libraries
• Native Python 3: Full migration to Python 3 native methods and imports

🔧 Development Infrastructure

Modern CI/CD Pipeline

• GitHub Actions: Replaced Travis CI with GitHub Actions
• Multi-version testing: Automated testing across Python 3.8-3.13
• Automated releases: New release workflow with PyPI publishing
• Quality assurance: SonarCloud integration for code quality monitoring

Enhanced Testing

• YAML storage backend tests: Comprehensive unit tests for YAML functionality
• Improved coverage: Enhanced test coverage reporting
• Better test isolation: Improved test environment setup

🛡️ Security Improvements

Security Vulnerability Fixes

• GitPython update: Fixed security vulnerabilities by updating to GitPython 3.1.41
• Jinja2 security: Fixed auto-escaping security issue in LatexJinja2 output
• Logging security: Fixed security issue with publicly writable directory usage in logging

📚 Documentation & Usability

Updated Documentation

• Modern README: Converted from RST to Markdown with updated examples
• Command examples: All examples now use rmtoo-contrib-dir command
• Installation guide: Updated installation instructions with current best practices
• Man pages: Updated all man pages to reference new commands and workflows

Template Project Improvements

• Easier access: Use rmtoo-contrib-dir for reliable template project location
• Updated examples: All documentation examples use the new command
• Cross-platform consistency: Same commands work on Windows, macOS, and Linux

🔧 Technical Improvements

Code Quality

• Dependency cleanup: Removed unused dependencies and legacy code
• Refactoring: Eliminated duplicate code in LaTeX output classes
• Bug fixes: Fixed syntax errors in tracer reconfiguration and logging
• Modernization: Updated code to use modern Python 3 idioms

Build System

• Improved packaging: Enhanced setup.py with better metadata
• Release automation: Streamlined release process with GitHub Actions
• PyPI publishing: Automated PyPI package publishing

🐛 Bug Fixes

Documentation Fixes

• Status requirement: Fixed incomplete Status requirement documentation in man pages
• Broken links: Removed links to non-existing web pages
• Header updates: Updated copyright headers to reflect current year

Configuration Fixes

• Tracer logging: Fixed tracer logging configuration not being applied
• YAML parsing: Improved YAML file parsing and error handling

Statistics and Estimation Fixes

• Date overflow error: Fixed crash when linear regression produces unrealistic end date estimates
• Variable name collision: Fixed bug in statistics calculation where loop variables conflicted
• Gradient bounds checking: Added validation for extremely small gradients indicating no meaningful progress

🔄 Migration Guide

For Existing Users

• No breaking changes: All existing functionality continues to work
• Optional upgrades: You can gradually adopt new features like YAML and rmtoo-contrib-dir
• Template projects: Update your scripts to use rmtoo-contrib-dir for future compatibility

For New Users

• Easier installation: pip install rmtoo now works more reliably
• Simpler setup: Use rmtoo-contrib-dir to find templates and resources
• Better documentation: Updated guides and examples throughout

📊 Statistics

• 55+ commits since version 25.0.0
• 4+ years of continuous development
• 6 new Python versions supported (3.8-3.13)
• Multiple security fixes and improvements
• Enhanced testing across all supported platforms

🙏 Acknowledgments

Thanks to all contributors who helped improve rmToo over the past 4 years through bug reports, feature suggestions, and code contributions.

Support for python 3.5 - 3.8

Include support / tests for all currently supported python versions: 3.5, 3.6, 3.7, 3.8

Preinstalled VMs

Added automatic VM creation: it is now possible to use predefined AWS EC2 Community Images preinstalled with rmtoo.

Maintenance Release

This is the first release of rmtoo after about five years. The feature set did not change - but there were many cleanups and improvements in the background: python3 support, pip / pypi support, many code cleanups and refactorings.
It is now possible to run rmtoo in a virtualenv using pip.

Bug Fix Release

Added support for Test Cases. Fixed latex2 output: there was a bug that the references were printed many times when there were more than one reference to another requirement. Fixed error reporting: there was an error that problems during parsing the requirements / topics / constraints directories were not reported to the user at all. Instead a python stack trace was printed. This was fixed: now the user sees exactly the problems - if there were some. Fixed long path names in graph2 output: Since v22 it is possible to use subdirectories with requirements. This results in long names. These long names are now split up into some lines - with the '/' is the indicator where to split. Fixed priority list output: there was a bug that only the requirements were used for the prios list which are in the last topic worked on. This is fixed now: all requirements appear (again) in the prios list.