v0.18.3

2024-06-05

Changed:

• Binary Tree Constructor: Type hints to return more generic TypeVar for use with subclasses.
• DAG Constructor: Type hints to return more generic TypeVar for use with subclasses.
• [#247] Tree Construct: Type hints to return more generic TypeVar for use with subclasses.
• Tree Modifier: Type hints to return more generic TypeVar for use with subclasses.
• Misc: Documentation to include more contribution information and guidelines.

What's Changed

• docs: Fix links by @kayjan in #245
• docs: Refactor docs and add more contributing information by @kayjan in #246
• Fix type hints by @kayjan in #248
• bump: v0.18.3 by @kayjan in #249

Full Changelog: 0.18.2...0.18.3

v0.18.2

2024-06-01

Changed:

• Tree Search: Standardize handling of singular and plural search.
• Tree Search: Added find_relative_path that return a single node from search and rename existing find_relative_path to find_relative_paths. This might not be backwards-compatible!

What's Changed

• Modify search by @kayjan in #244

Full Changelog: 0.18.1...0.18.2

v0.18.1

2024-05-30

Changed:

• Misc: Remove support of Python 3.7 due to incompatibility with polars.

Fixed:

• Tree Constructor and Exporter: Error handling when user only partially download optional dependencies of pandas/polars.

What's Changed

• test: Add polars test for binary tree by @kayjan in #236
• docs: Update README by @kayjan in #237
• docs: Update project description by @kayjan in #238
• docs: Update install instructions by @kayjan in #239
• fix: polars error handling and python 3.7 support by @kayjan in #240
• docs: Update docs for installation instruction by @kayjan in #241
• bump: v0.18.1 by @kayjan in #242
• docs: Update README by @kayjan in #243

Full Changelog: 0.18.0...0.18.1

v0.18.0

2024-05-28

Added:

• Tree Constructor: Polars method polars_to_tree, polars_to_tree_by_relation, add_polars_to_tree_by_path, and add_polars_to_tree_by_name.
• Tree Exporter: Polars method tree_to_polars.

Fixed:

• Misc: Documentation to update mkdocs-material version for social plugin.
• Misc: Update links in README.
• Misc: Fix mypy typing.

What's Changed

• Fix mkdocs deploy by @kayjan in #227
• build: Check python version by @kayjan in #228
• fix: update codecov version for github actions by @kayjan in #229
• fix: update codecov version for github actions by @kayjan in #230
• Fix mypy by @kayjan in #231
• Add polars by @kayjan in #235

Full Changelog: 0.17.2...0.18.0

v0.17.2

2024-04-24

Changed:

• DAG Constructor: list_to_dag and dict_to_dag does not rely on dataframe_to_dag as pandas dataframe operation is phased out.

Fixed:

• DAG Constructor: Handle cases where reserved keywords are part of attribute upon creation and throw error accordingly.
• [#224] Tree/DAG Constructor: Null checks to not interpret 0 as null, this affects dataframe_to_tree_by_relation, add_dataframe_to_tree_by_path, add_dataframe_to_tree_by_name, dataframe_to_tree, and dataframe_to_dag. This will also affect showing/printing of trees when attr_omit_null is set to True.

What's Changed

• Abstract functions by @kayjan in #225
• fix: null checks to ignore zero values by @kayjan in #226

Full Changelog: 0.17.1...0.17.2

v0.17.1

2024-04-23

Fixed

• [#222] Tree Constructor: dataframe_to_tree_by_relation duplicate root node name error message to handle
  different data types.

What's Changed

• Docs: Fix Broken Read the Docs Links by @wlkr in #221
• fix: dataframe_to_tree_by_relation error message to handle different … by @kayjan in #223

New Contributors

• @wlkr made their first contribution in #221

Full Changelog: 0.17.0...0.17.1

v0.17.0

2024-04-04

Added

• Misc: Group tests for benchmark timings to compare the timings by multiplier more effectively.

Changed

• Tree Constructor: add_dict_to_tree_by_name and add_dataframe_to_tree_by_name modifies tree in-place instead of returning new tree, and does not accept join_type as argument as pandas dataframe operation is phased out. If there are clashing attributes, only those that have values will be replaced. This might not be backwards-compatible!
• Tree Constructor: dataframe_to_tree no longer relies on add_dataframe_to_tree_by_path as it performs assertion checks twice. This leads to 5% improvement in timings for a tree with 10000 nodes, averaged across 10 runs.
• Misc: Abstract out assertion checks for empty dataframe and duplicate attribute.
• Misc: Abstract out logic for checking null and filtering attributes.
• Misc: Optimization in dictionary and dataframe operations.

Fixed

• Tree Constructor: dict_to_tree no longer uses dataframe operations, leading to 33% improvement in timings for a tree with 10000 nodes, averaged across 10 runs. The resulting data type of node follows the dictionary exactly, compared to the previous dataframe operations that may change the dtypes for certain columns. This might not be backwards-compatible!
• Tree Constructor: dataframe_to_tree_by_relation fix root node detection logic, ignore existing name column, ignore non-attribute columns, ignore null attribute columns.
• Tree Constructor: add_dataframe_to_tree_by_path ignore existing name column, ignore non-attribute columns, ignore null attribute columns.
• Tree Constructor: add_dataframe_to_tree_by_name ignore existing name column, ignore non-attribute columns, ignore null attribute columns.
• Tree Constructor: dataframe_to_tree ignore existing name column, ignore non-attribute columns, ignore null attribute columns.
• DAG Constructor: dataframe_to_dag ignore existing name column, ignore non-attribute columns, ignore null attribute columns.

What's Changed

• Optimization timings by @kayjan in #220

Full Changelog: 0.16.4...0.17.0

v0.16.4

2024-03-14

Fixed

• [#216] Tree Exporter: Fix nan checker when printing trees.

What's Changed

• Fix nan check by @kayjan in #219

Full Changelog: 0.16.3...0.16.4

v0.16.3

2024-03-14

Added

• BaseNode: Add diameter property.
• Misc: Testing to include benchmark timings for tree creation, compare benchmark tests across commits, reject pull request if benchmark tests fails.
• Misc: Documentation to include benchmark results.

Changed

• Misc: Documentation to enable zooming in of images, add navigation section headers, remove some meta tags.
• Misc: Split up testing into multiple conftest files.

Fixed

• Tree Constructor: Tree creation from dictionary adds None for empty attributes instead of np.nan.
• [#216] Tree Exporter: attr_omit_null to handle nan/null values in addition to checking for None.

What's Changed

• Docs image by @kayjan in #187
• Added: zoom to documentation image, add requirements by @kayjan in #188
• Added: navigation section header by @kayjan in #189
• Changed: Remove some meta tags from overrides html by @kayjan in #190
• Fix pytest by @kayjan in #192
• Update codecov.yml by @kayjan in #193
• Pytest benchmark by @kayjan in #191
• Pytest benchmark by @kayjan in #195
• Benchmark precision by @kayjan in #196
• Fixed: Clear cache for benchmark upon merge to main by @kayjan in #197
• Fixed: Clear cache by @kayjan in #198
• Fixed: Clear cache command by @kayjan in #199
• Fixed: Add permission for actions by @kayjan in #200
• Changed: Skip if cache not found by @kayjan in #201
• Add: index.html for benchmark results by @kayjan in #202
• Changed: clear cache before saving cache by @kayjan in #203
• Changed: Auto push benchmark by @kayjan in #204
• Added: benchmark dir path by @kayjan in #205
• Changed: Save benchmark result for comparison and gh-pages by @kayjan in #206
• Changed: Change benchmark save dir from gh-pages to master by @kayjan in #207
• Changed: Push to gh-pages only upon merge by @kayjan in #208
• Benchmark another repo by @kayjan in #209
• Added: Documentation to link to benchmark results by @kayjan in #210
• Changed: Benchmark results on documentation better format by @kayjan in #211
• Changed: Remove scrolling from iframe by @kayjan in #212
• Update: Fixed source code by @kayjan in #213
• Add diameter by @kayjan in #214
• Fix nan by @kayjan in #217

Full Changelog: 0.16.2...0.16.3

v0.16.2

2024-02-06

Added

• Misc: Documentation plugin Termynal for code animation.
• Misc: Usage of docstr-coverage.
• Misc: Docstrings for nested functions to pass docstr-coverage.

Changed

• [#185] BaseNode: Make assertion checks optional.
• Misc: Documentation CSS for h1 display for windows compatibility, modify the related links on main page.

What's Changed

• Changed: Update custom.css for h1 color by @kayjan in #181
• Changed: Update mkdocs css by @kayjan in #182
• Added: mkdocs integration with termynal by @kayjan in #183
• Update changelog by @kayjan in #184
• Optional assertions by @kayjan in #186

Full Changelog: 0.16.1...0.16.2