refact: big refactoring

[davidsbatista]

Overview

• Improving code structure and maintainability through refactoring.
• No original code was changed - the changes are purely structural, moving existing functionality into a more organized class-based architecture.

Key Changes

Code Restructuring

• Refactored evaluation logic into proper classes
• Moved existing data loading methods into dedicated loader classes
• Integrated reporting methods as class methods

Code Quality Improvements

• Added comprehensive test coverage
• Implemented better error handling
• Enhanced code documentation (docstrings)
• Added some type hints

Verification

The compare_versions.py script has been added to verify that the old and new code produce identical output content. While the results are functionally equivalent, the new code provides better visualisation for the reporting based on indices

Testing

• All existing tests pass
• New test cases added for new code

[davidsbatista]

Hi @ivyleavedtoadflax! I did a big refactoring on this code - I think it deserved it. I still kept the old functionality.

I suggest we make a release with some warnings for upcoming breaking changes - and after 1 or 2 weeks we release this new version. What do you think?

[ivyleavedtoadflax]

Great @davidsbatista, yes I think it deserved it. I will give this a review, but agree with the idea of a release warning about breaking changes in the meantime

[ivyleavedtoadflax]

Looks, good, much tidier! LGTM 🥳

[ivyleavedtoadflax]

@davidsbatista looks good, happy to approve. Let's go ahead with the warning about breaking changes in the meantime, and you can approve once we've given a couple of weeks warning.

[davidsbatista]

@ivyleavedtoadflax adding deprecation warnings here

[davidsbatista]

removing old code, so that only the new version works - @ivyleavedtoadflax let me know when you release the current main which has the warnings merged

[ivyleavedtoadflax]

@ivyleavedtoadflax let me know when you release the current main which has the warnings merged

Done

[davidsbatista]

somehow pip index is not showing the last release, only one from last year is availalbe