Pyhelpers

(*10 January 2025*)

Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/2.0.0...2.1.0) since [2.0.0](https://pypi.org/project/pyhelpers/2.0.0/):

- Resolved several identified issues for improved stability.
- Introduced new features and fixed various bugs.
- Deployed GitHub Pages as an alternative for documentation hosting to Read the Docs.

**For more information and detailed specifications, check out the [PyHelpers 2.1.0 documentation](https://pyhelpers.readthedocs.io/en/2.1.0/).**

(*30 July 2024*)

Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/1.5.2...2.0.0) since [1.5.2](https://pypi.org/project/pyhelpers/1.5.2/):

- **Major Release:** Version 2.0.0 features significant improvements to code and docstrings.
- *Code enhancements*: Optimised performance and refactored core modules for better readability and maintainability.
- *Bug fixes*: Resolved issues identified in practical use.
- **License Update:** This new release is re-licensed under the [MIT License](https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE), providing more clarity, flexibility and usability.

**For more information and detailed specifications, check out the [PyHelpers 2.0.0 documentation](https://pyhelpers.readthedocs.io/en/2.0.0/).**

(*13 September 2023*)

Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/1.5.1...1.5.2) since [1.5.1](https://pypi.org/project/pyhelpers/1.5.1/):

- Turned the module [dbms](https://github.com/mikeqfu/pyhelpers/commit/14a0c902d43a4eabcf0044777afb550cd3468a47#diff-402d385f94d69cd9596a357c63ccdf2d12f55165339af5d3c1bd554fb5a5e146) into a [sub-package](https://github.com/mikeqfu/pyhelpers/commit/14a0c902d43a4eabcf0044777afb550cd3468a47#diff-6e2acc03b11f525b7b7e640c7d6d29d0e395dd1edfbbb74f96359d4019432b63).

**For more information and detailed specifications, check out [PyHelpers 1.5.2 documentation](https://pyhelpers.readthedocs.io/en/1.5.2/).**

(*17 June 2023*)

Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/1.5.0...1.5.1) since [1.5.0](https://pypi.org/project/pyhelpers/1.5.0/):

- Renamed arguments for the functions of saving/loading data within the module [store](https://github.com/mikeqfu/pyhelpers/commit/fb1629caf52af8382967d16dd1888b44da33d1b9).
- Modified the following functions:
- [save_spreadsheet()](https://github.com/mikeqfu/pyhelpers/commit/fb1629caf52af8382967d16dd1888b44da33d1b9?diff=unified#diff-5be4770b2702d34ea60ff69d076c06b6311d2de302323f4313f5829f857e7607L170-R265) in the module [store](https://github.com/mikeqfu/pyhelpers/blob/21d8271cc0cfc8e01ee183f3c7e192b02e047a73/pyhelpers/store.py);
- [find_similar_str()](https://github.com/mikeqfu/pyhelpers/commit/b99678ba7cf1e493a01b4461d4352264ccf15c1c) in the module [text](https://github.com/mikeqfu/pyhelpers/blob/21d8271cc0cfc8e01ee183f3c7e192b02e047a73/pyhelpers/text.py).

**For more information and detailed specifications, check out [PyHelpers 1.5.1 documentation](https://pyhelpers.readthedocs.io/en/1.5.1/).**

(*8 June 2023*)

Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/1.4.6...1.5.0) since [1.4.6](https://pypi.org/project/pyhelpers/1.4.6/):

- Improved the structure of the package and a few functions and class methods.
- Added the following new functions/classes:
- [path2linux()](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/dirs.py#L251-L279), [validate_filename()](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/dirs.py#L417-L480), [get_file_pathnames()](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/dirs.py#L487-L549), and [check_files_exist()](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/dirs.py#L552-L598) to the module [dir](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/dirs.py);
- [GitHubFileDownloader()](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/ops.py#L2313-L2567) and [func_running_time()](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/ops.py#L481-L516) to the module [ops](https://github.com/mikeqfu/pyhelpers/blob/85d483e35f34ff8a766c203d920bf04cf7a82c00/pyhelpers/ops.py).

**For more information and detailed specifications, check out [PyHelpers 1.5.0 documentation](https://pyhelpers.readthedocs.io/en/1.5.0/).**

(*26 February 2023*)

Notable [changes](https://github.com/mikeqfu/pyhelpers/compare/1.4.5...1.4.6) since [1.4.5](https://pypi.org/project/pyhelpers/1.4.5/):

- Improved the module [dbms](https://github.com/mikeqfu/pyhelpers/blob/6602ace1cf7c04731970c01e01c0ad29f45a4b62/pyhelpers/dbms.py) (for migrating to SQLAlchemy 2.0).
- Improved the following functions (with bug fixes):
- [cmap_discretisation()](https://github.com/mikeqfu/pyhelpers/commit/c268c3e70fe2812102d90c9739e9c9c636c42977) in the module [ops](https://github.com/mikeqfu/pyhelpers/blob/24f56435571f9a72810ee6eca63e22289b917335/pyhelpers/ops.py);
- [find_closest_points()](https://github.com/mikeqfu/pyhelpers/commit/117d5c3469a029e38ecf3d35d2a3d6f7c2eadaf2) in the module [geom](https://github.com/mikeqfu/pyhelpers/blob/24f56435571f9a72810ee6eca63e22289b917335/pyhelpers/geom.py);
- [save_web_page_as_pdf()](https://github.com/mikeqfu/pyhelpers/commit/e0ff2cfa36c0d4811d71274faff27fe8b5fb7a9d) in the module [store](https://github.com/mikeqfu/pyhelpers/blob/24f56435571f9a72810ee6eca63e22289b917335/pyhelpers/store.py).

**For more information and detailed specifications, check out [PyHelpers 1.4.6 documentation](https://pyhelpers.readthedocs.io/en/1.4.6/).**