This pull request aims to enhance the project by making various improvements in documentation, tests, and code. The key changes include improved documentation with 100% docstring coverage, an updated colab example, and an updated README.md. The tests have been improved to achieve 100% test coverage, as reported by Coveralls. The code has been enhanced with increased modularity, the addition of a State Enum, the relocation of temporary files to the tempfile module, and the deletion of temporary files after use. Other changes include upgrading from setup.py to pyproject.toml, removing the Manual driver, exposing the chunksize parameter, and making the download methods' interfaces more consistent. Code reusability has also been improved.
Changes Made:
Improved Documentation
Achieved 100% docstring coverage using the interrogate tool.
Updated the colab example to provide better guidance.
Updated the README.md file to reflect the latest changes and provide clear instructions.
Improved Tests
Achieved 100% test coverage as reported by Coveralls.
Expanded test cases to cover all aspects of the code.
Improved Code
Introduced greater modularity to improve code organization and maintainability.
Added a State Enum to provide a standardized representation of states.
Moved temporary file handling to the tempfile module for better file management.
Implemented file cleanup by deleting temporary files after use.
Upgraded from the setup.py configuration file to pyproject.toml for better compatibility.
Removed the Manual driver to streamline the codebase.
Exposed the chunk_size parameter to allow users to customize the download behavior.
Made the interfaces of the download_ methods more consistent for improved usability.
Enhanced code reusability to avoid duplication and promote maintainability.
These changes aim to enhance the project's overall quality, maintainability, and usability. They have been thoroughly tested to ensure reliability.
Summary:
This pull request aims to enhance the project by making various improvements in documentation, tests, and code. The key changes include improved documentation with 100% docstring coverage, an updated colab example, and an updated README.md. The tests have been improved to achieve 100% test coverage, as reported by Coveralls. The code has been enhanced with increased modularity, the addition of a State Enum, the relocation of temporary files to the tempfile module, and the deletion of temporary files after use. Other changes include upgrading from setup.py to pyproject.toml, removing the Manual driver, exposing the chunksize parameter, and making the download methods' interfaces more consistent. Code reusability has also been improved.
Changes Made:
chunk_sizeparameter to allow users to customize the download behavior.download_methods more consistent for improved usability.These changes aim to enhance the project's overall quality, maintainability, and usability. They have been thoroughly tested to ensure reliability.