Proactive Validation Enhancements and CI Integration
What's New in Version 0.1.9
- Proactive Validation Enhancements: Enhanced the
is_subset
function to raise descriptiveValueErrors
for each validation failure, improving the clarity and maintainability of error handling. - Documentation Updates: Updated all documentation to reflect changes in code and added examples on how to handle new validation exceptions.
Continuous Integration Improvements
- Python Package Testing Workflow: Introduced a new GitHub Actions workflow to automate the testing process, ensuring that each push or pull request to the 'main' branch triggers a series of actions that validate the codebase across different environments and Python versions.
- Setup steps for Python environment and dependencies using Poetry.
- Code linting with flake8 to enforce coding standards and identify issues early.
- Automated tests with pytest to verify that new changes do not break existing functionalities.
- Documentation build using Sphinx to keep the project documentation up to date.
Documentation and README Updates
- Enhanced Documentation: Updated the documentation and README files to better reflect the current functionalities and how to implement the module within other projects.
- Workflow Integration: Detailed the inclusion of a new GitHub Actions workflow that automates testing across multiple Python versions (3.9, 3.10, 3.11, 3.12) to ensure compatibility and reliability.
- Example Code Added: New example codes and usage scenarios have been added to the documentation to assist users in understanding how to use the validation features effectively.
Other Improvements
- Simplified File Path Extraction: Refactored string handling to ensure compatibility with Python versions 3.9 to 3.11, making the codebase more future-proof.
Improvements
- Improved error message clarity in the validation process.
We encourage all users to update to this latest version to benefit from these improvements.