Skip to content

Commit b075836

Browse files
mikeqfumikeqfu
authored
2.2.0dev (Refactoring, enhancements & bug fixes) (#72)
1 parent 6b222eb commit b075836

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+6244
-4452
lines changed

‎CITATION.cff‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,13 @@ authors:
1818
identifiers:
1919
- type: doi
2020
value: 10.5281/zenodo.4017438
21+
description: >-
22+
This DOI represents all versions of PyHelpers, and will
23+
always resolve to the latest one.
2124
repository-code: 'https://github.com/mikeqfu/pyhelpers'
22-
url: 'https://pyhelpers.readthedocs.io'
23-
repository: 'https://pypi.org/project/pyhelpers/'
25+
url: 'https://mikeqfu.github.io/pyhelpers/'
26+
repository: 'https://pyhelpers.readthedocs.io'
27+
repository-artifact: 'https://pypi.org/project/pyhelpers/'
2428
abstract: >-
2529
PyHelpers is an open-source Python package designed to
2630
streamline data (pre-)processing and manipulation tasks.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 Qian Fu
3+
Copyright (c) 2019-2025 Qian Fu
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎MANIFEST.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
recursive-include pyhelpers/data *
33

44
# Exclude tests
5-
recursive-exclude tests *
5+
prune tests

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# PyHelpers
22

3-
[![PyPI - Version](https://img.shields.io/pypi/v/pyhelpers)](https://pypi.org/project/pyhelpers/)
4-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyhelpers)](https://docs.python.org/3/)
3+
[![PyPI Release Version](https://img.shields.io/pypi/v/pyhelpers)](https://pypi.org/project/pyhelpers/)
4+
[![Python Version](https://img.shields.io/pypi/pyversions/pyhelpers)](https://docs.python.org/3/)
55
[![License](https://img.shields.io/github/license/mikeqfu/pyhelpers)](https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE)
6-
[![Read the Docs - Documentation](https://img.shields.io/readthedocs/pyhelpers?logo=readthedocs)](https://pyhelpers.readthedocs.io/en/latest/?badge=latest)
7-
[![GitHub Pages - Documentation](https://img.shields.io/github/actions/workflow/status/mikeqfu/pyhelpers/github-pages.yml?logo=github&label=docs)](https://mikeqfu.github.io/pyhelpers/)
6+
[![ReadTheDocs Documentation](https://img.shields.io/readthedocs/pyhelpers?logo=readthedocs)](https://pyhelpers.readthedocs.io/en/latest/?badge=latest)
7+
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mikeqfu/pyhelpers/github-pages.yml?logo=github&branch=master)](https://github.com/mikeqfu/pyhelpers/actions)
88
[![Codacy - Code Quality](https://app.codacy.com/project/badge/Grade/c3ed8571c494450da12cb0c4d3c8c7e9)](https://app.codacy.com/gh/mikeqfu/pyhelpers/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
99
[![DOI](https://img.shields.io/badge/10.5281%2Fzenodo.4017438-blue?label=doi)](https://doi.org/10.5281/zenodo.4017438)
1010

@@ -56,4 +56,6 @@ For specific version references, please refer to [Zenodo](https://zenodo.org/sea
5656

5757
## License
5858

59-
PyHelpers (since v2.0.0) is licensed under the [MIT License](https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE).
59+
PyHelpers is licensed under the [MIT License](https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE).
60+
61+
Please note that this project was initially licensed under the [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text) up to version *1.5.2*. Starting with version *2.0.0*, it has been re-licensed under the MIT License.

‎docs/source/conf.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,8 +349,11 @@ def __init__(self, **options):
349349
{\endoldlongtable}
350350
\usepackage[open,openlevel=1]{bookmark}
351351
\bookmarksetup{numbered}
352-
353352
\addto\captionsenglish{\renewcommand{\contentsname}{Table of Contents}}
353+
\usepackage{xcolor}
354+
\usepackage{newunicodechar}
355+
\definecolor{ansiGreen}{RGB}{34, 139, 34}
356+
\newunicodechar{█}{\textcolor{ansiGreen}{\rule{0.6em}{0.6em}}}
354357
'''
355358

356359
# LaTeX customisation:

‎docs/source/dbms.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ Database tools/utilities
3535
make_database_address
3636
get_default_database_address
3737
add_sql_query_condition
38-
mssql_to_postgresql
3938
import_data
4039
read_data
40+
mssql_to_postgresql

‎docs/source/dirs.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ Directory validation
3434
get_file_pathnames
3535
check_files_exist
3636

37-
Directory/file control
38-
----------------------
37+
Directory/file management
38+
-------------------------
3939

4040
.. autosummary::
4141
:toctree: _generated/
4242
:template: function.rst
4343

44+
add_slashes
4445
delete_dir

‎docs/source/geom.rst‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,64 +8,65 @@ geom
88
:no-members:
99
:no-inherited-members:
1010

11-
Geometric data transformation
11+
Distance-related calculations
1212
-----------------------------
1313

14-
.. rubric:: Data type
1514
.. autosummary::
1615
:toctree: _generated/
1716
:template: function.rst
1817

19-
transform_point_type
20-
get_coordinates_as_array
18+
calc_distance_on_unit_sphere
19+
calc_hypotenuse_distance
20+
find_closest_point
21+
find_closest_points
22+
find_shortest_path
2123

22-
.. rubric:: Coordinate system
24+
Geometric properties and shape sketching
25+
----------------------------------------
26+
27+
.. rubric:: Properties
2328
.. autosummary::
2429
:toctree: _generated/
2530
:template: function.rst
2631

27-
wgs84_to_osgb36
28-
osgb36_to_wgs84
32+
get_midpoint
33+
get_geometric_midpoint
34+
get_geometric_midpoint_calc
35+
get_rectangle_centroid
36+
get_square_vertices
37+
get_square_vertices_calc
2938

30-
.. rubric:: Dimension / Projection
39+
.. rubric:: Sketching
3140
.. autosummary::
3241
:toctree: _generated/
3342
:template: function.rst
3443

35-
drop_axis
36-
project_point_to_line
44+
sketch_square
3745

38-
Geometric data computation
39-
--------------------------
46+
Geometric data transformation
47+
-----------------------------
4048

41-
.. rubric:: Distance
49+
.. rubric:: Data type
4250
.. autosummary::
4351
:toctree: _generated/
4452
:template: function.rst
4553

46-
calc_distance_on_unit_sphere
47-
calc_hypotenuse_distance
48-
find_closest_point
49-
find_closest_points
50-
find_shortest_path
54+
transform_point_type
55+
get_coordinates_as_array
5156

52-
.. rubric:: Locating
57+
.. rubric:: Coordinate system
5358
.. autosummary::
5459
:toctree: _generated/
5560
:template: function.rst
5661

57-
get_midpoint
58-
get_geometric_midpoint
59-
get_geometric_midpoint_calc
60-
get_rectangle_centroid
61-
get_square_vertices
62-
get_square_vertices_calc
63-
64-
Geometric data sketching
65-
------------------------
62+
wgs84_to_osgb36
63+
osgb36_to_wgs84
6664

65+
.. rubric:: Dimension / Projection
6766
.. autosummary::
6867
:toctree: _generated/
6968
:template: function.rst
7069

71-
sketch_square
70+
drop_axis
71+
project_point_to_line
72+

‎docs/source/index.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22
PyHelpers
33
=========
44

5-
|PyPI - Version| |PyPI - Python Version| |Read the Docs - Documentation| |GitHub Pages - Documentation| |License| |Codacy - Code Quality| |Zenodo - DOI|
5+
|PyPI| |Python| |License| |Docs| |Build| |Codacy| |DOI|
66

7-
.. |PyPI - Version| image:: https://img.shields.io/pypi/v/pyhelpers
8-
:alt: PyPI - Version
7+
.. |PyPI| image:: https://img.shields.io/pypi/v/pyhelpers
8+
:alt: PyPI Release Version
99
:target: https://pypi.org/project/pyhelpers/
10-
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/pyhelpers
11-
:alt: PyPI - Python Version
10+
.. |Python| image:: https://img.shields.io/pypi/pyversions/pyhelpers
11+
:alt: Python Version
1212
:target: https://docs.python.org/3/
1313
.. |License| image:: https://img.shields.io/github/license/mikeqfu/pyhelpers
1414
:alt: License
1515
:target: https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE
16-
.. |Read the Docs - Documentation| image:: https://img.shields.io/readthedocs/pyhelpers?logo=readthedocs
17-
:alt: Read the Docs - Documentation
16+
.. |Docs| image:: https://img.shields.io/readthedocs/pyhelpers?logo=readthedocs
17+
:alt: ReadTheDocs Documentation
1818
:target: https://pyhelpers.readthedocs.io/en/latest/?badge=latest
19-
.. |GitHub Pages - Documentation| image:: https://img.shields.io/github/actions/workflow/status/mikeqfu/pyhelpers/github-pages.yml?logo=github&label=docs
20-
:alt: GitHub Pages - Documentation
21-
:target: https://mikeqfu.github.io/pyhelpers/
22-
.. |Codacy - Code Quality| image:: https://app.codacy.com/project/badge/Grade/c3ed8571c494450da12cb0c4d3c8c7e9
19+
.. |Build| image:: https://img.shields.io/github/actions/workflow/status/mikeqfu/pyhelpers/github-pages.yml?logo=github&branch=master
20+
:alt: GitHub Actions Workflow Status
21+
:target: https://github.com/mikeqfu/pyhelpers/actions
22+
.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/c3ed8571c494450da12cb0c4d3c8c7e9
2323
:alt: Codacy - Code Quality
2424
:target: https://app.codacy.com/gh/mikeqfu/pyhelpers/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
25-
.. |Zenodo - DOI| image:: https://img.shields.io/badge/10.5281%2Fzenodo.4017438-blue?label=doi
26-
:alt: Zenodo - DOI
25+
.. |DOI| image:: https://img.shields.io/badge/10.5281%2Fzenodo.4017438-blue?label=doi
26+
:alt: DOI
2727
:target: https://doi.org/10.5281/zenodo.4017438
2828

2929
| **Author**: Qian Fu |ORCID|

‎docs/source/license.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ License
33
=======
44

55
- PyHelpers (since version 2.0.0) is licensed under the `MIT License <https://github.com/mikeqfu/pyhelpers/blob/master/LICENSE>`_.
6-
- Versions 1.5.2 and earlier are licensed under the `GPLv3+ <https://github.com/mikeqfu/pyhelpers/blob/1.5.2/LICENSE>`_ License).
6+
- Versions 1.5.2 and earlier are licensed under the `GPLv3+ <https://github.com/mikeqfu/pyhelpers/blob/1.5.2/LICENSE>`_ License.

0 commit comments

Comments
 (0)