Skip to content

Code Refactoring and Documentation Enhancements
Compare
Choose a tag to compare
@atellaluca atellaluca released this 14 Oct 17:07
· 60 commits to main since this release
v0.1.7
cb0996d

ersion v0.1.7 brings significant improvements and optimizations to ImportSpy, including code restructuring, documentation enhancements, and new usage examples to streamline the adoption of the package.

Key Highlights

  • Documentation Improvements:

    • The README has been converted to .rst format for better compatibility with Sphinx.
    • New usage examples have been added to demonstrate how to use ImportSpy in modular systems and plugin-based architectures.
    • Documentation has been updated to version 0.1.7, including enhanced API references for better understanding.

  • Code Refactoring:

    • Code has been reorganized to improve readability and maintainability.
    • Docstrings have been enhanced to adhere to Python and Sphinx standards, making it easier to automatically generate documentation.
    • Removed outdated examples and migrated the README to .rst format.

  • New Import Validation Example:

    • A complete new example demonstrates how ImportSpy can enforce rules on modules importing your code.
    • This example includes both rule definitions in developer_code.py and the implementation of those rules in importing_module.py.

How to Upgrade

To upgrade to the latest version of ImportSpy, run the following command:

pip install --upgrade importspy
Assets 2
Loading