V4.1 - Improving the Substantial Metrics Change PyDriller Feature CSV File Output

Release 4.1 - Improving the Substantial Metrics Change PyDriller Feature CSV File Output

Summary of Changes

The transition from release 4.0 to 4.1 introduced several enhancements and refinements to the PyDriller tool. Key improvements include:

1. Submodule Management:

   • Integrated my forked CK project as a submodule in the Worked-Example-Miner tool, ensuring a seamless update process for the CK tool.
   • Implemented a GitHub Actions workflow to automatically update the CK submodule every hour.

2. Code Refactoring:

   • Updated various directory and branch names within the workflow to maintain consistency.
   • Refactored functions in the PyDriller code to improve readability and structure, including updating the return values and order of function calls to follow a bottom-up standard.

3. Verbose Output Functionality:

   • Introduced a verbose mode function that enhances debugging and tracking by printing detailed outputs in the PyDriller code.
   • Replaced standard print statements with the new verbose output function across multiple Python files for consistency.

4. Metrics Enhancements:

   • Added an occurrences counter to the metrics changes code, enhancing the output files generated by PyDriller.
   • Improved the CSV file output of the substantial metrics change feature, ensuring clearer and more comprehensive data representation.

5. Documentation Updates:

   • Updated documentation and docstring conventions to reflect changes in the codebase and improve clarity for future developers.

6. Dependency Management:

   • Upgraded the pillow library dependency from version 10.2.0 to 10.3.0, ensuring compatibility and incorporating the latest features and fixes.

7. Fixes:

   • Addressed issues with handling inner class names from the RefactoringMiner file path in JSON outputs, improving the robustness of the tool.

Conclusion

These updates aim to enhance the functionality and maintainability of the PyDriller tool, providing a more effective environment for analyzing and processing code metrics.

What's Changed

• Build(deps): Bump pillow from 10.2.0 to 10.3.0 in /PyDriller by @dependabot in #1

Full Changelog: v4.0...v4.1