🍂 Changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.15.7 - 2023-01-26

Added

  • Misc: Sphinx documentation to support mermaid markdown images, reflect CHANGELOG section, add more emojis.

Changed

  • Misc: Update SEO image.

  • Misc: Fix Sphinx documentation font size difference between web and mobile, include last updated date.

  • Misc: Upgrade package versions in pre-commit hook.

Fixed

  • Tree Exporter: hprint_tree and hyield_tree to be compatible with BinaryNode where child nodes can be None type.

0.15.6 - 2023-01-20

Added

  • DAGNode: Able to access and delete node children via name with square bracket accessor with __getitem__ and __delitem__ magic methods.

  • DAGNode: Able to delete all children for a node.

  • DAGNode: Able to check if node contains child node with __contains__ magic method.

  • DAGNode: Able to iterate the node to access children with __iter__ magic method.

Changed

  • Tree Search: Modify type hints to include DAGNode for find_children, find_child, and find_child_by_name.

  • Misc: Neater handling of strings for tests.

  • Misc: Documentation enhancement to split README into multiple files.

  • Misc: New Sphinx documentation theme.

0.15.5 - 2023-01-17

Changed

  • Misc: Neater handling of strings for tests.

  • Misc: Better examples for merging trees and weighted trees in Sphinx documentation.

  • Misc: Fix links and introduce unreleased segment in CHANGELOG.

0.15.4 - 2024-01-11

Changed

  • Tree Exporter: hprint_tree and hyield_tree to allow hiding names of intermediate node.

Fixed

  • Tree Constructor: newick_to_tree to handle invalid closing and use of apostrophe.

  • Tree Exporter: tree_to_newick to handle special characters by wrapping them in apostrophe.

0.15.3 - 2024-01-08

Added

  • Tree Helper: get_subtree method to retrieve subtree.

0.15.2 - 2024-01-08

Added

  • Tree Exporter: hprint_tree and hyield_tree to print and retrieve results for tree in horizontal orientation.

  • Node: Added hshow method to print tree in horizontal orientation to console.

0.15.1 - 2024-01-05

Added

  • Tree Constructor: newick_to_tree to convert Newick notation to tree.

Changed

  • Tree Exporter: tree_to_newick to accept more parameters to parse length and attributes.

Fixed

  • Misc: Automated doctest setup to use os operations instead of string operations.

0.15.0 - 2024-01-02

Added

  • Tree Exporter: Export to Newick notation with tree_to_newick.

Changed

  • Tree Helper: Pruning tree to support pruning of multiple paths (accepts list of string).

  • Tree Helper: Pruning tree to support pruning of an exact path (i.e., remove descendants) with exact parameter, default is prune and keep descendants.

0.14.8 - 2023-12-25

Changed

  • Tree Modifier: Enhance documentation examples.

  • Workflow To Do App: Change import and export logic.

  • Misc: Organize assets folder based on whether it originated from README, docstrings, or sphinx documentation.

  • Misc: Rename functions in plot.py utils file for coverage report.

Fixed

  • Misc: Fixed doctests and automate doctest checks.

0.14.7 - 2023-12-22

Changed

  • Tree Helper: get_tree_diff enhanced to compare tree attributes by taking in attr_list parameter, and indicates difference with (~).

Fixed

  • Tree Helper: get_tree_diff compare tree structure by considering all nodes (previously only consider leaf nodes).

0.14.6 - 2023-12-14

Added

  • Node: Able to access and delete node children via name with square bracket accessor with __getitem__ and __delitem__ magic methods.

  • BaseNode/Node/BinaryNode: Able to add one or more children with append and extend methods.

  • BaseNode/Node/BinaryNode: Able to check if node contains child node with __contains__ magic method.

  • BaseNode/Node/BinaryNode: Able to iterate the node to access children with __iter__ magic method. Results in children setter to only accept list/tuple/set instead of iterable types.

Changed

  • Tree Exporter: tree_to_dot accepts callable to set node and edge attrs for custom node (backward-compatible).

  • Tree Exporter: tree_to_mermaid accepts callable to set node shape attr, edge arrow attr and node attr for custom node (backward-compatible).

  • Tree Exporter: Change delimiter for tree_to_mermaid to prevent possible path confusion (backward-compatible).

  • Misc: Code abstraction for assertion checks and constants.

  • Misc: Documentation for exporting tree/dag to dot.

0.14.5 - 2023-11-24

Changed

  • Misc: Update SECURITY file.

  • Misc: Documentation enhancement to add more emoji, and highlight code blocks.

0.14.4 - 2023-11-04

Changed

  • Misc: Clean up github actions.

0.14.3 - 2023-10-31

Added

  • Misc: Publish to conda, enable automated publishing to conda-forge in addition to existing PyPI.

  • Misc: Tree demonstration code for shift_and_replace_nodes and copy_and_replace_nodes_from_tree_to_tree in README.

0.14.2 - 2023-10-21

Added

  • Misc: RTD integration.

  • Misc: Enable manual publishing of python package.

0.14.1 - 2023-10-18

Added

  • Misc: Changes to main branch checks if the latest version exists (using git tag) before publishing package and building documentation.

0.14.0 - 2023-10-18

Added

  • Tree Modifier: Shift nodes with replacement of to-node with shift_and_replace_nodes.

  • Tree Modifier: Copy nodes from tree to tree with replacement of to-node with copy_and_replace_nodes_from_tree_to_tree.

  • Tree Modifier: Any permutation of configuration with replacement of to-node with replace_logic.

  • Tree Modifier: Add relevant test cases and documentations accordingly.

0.13.3 - 2023-10-17

Added

  • Misc: Add automatic release notes with content into GitHub workflow.

0.13.2 - 2023-10-17

Added

  • Misc: Add automatic release notes into GitHub workflow.

0.13.1 - 2023-10-15

Added

  • Misc: Add automatic comment on code coverage to pull requests into GitHub workflow.

  • Misc: Add more checks into pre-commit.

0.13.0 - 2023-09-29

Added

  • Tree Exporter: Export tree to flowchart diagram in mermaid markdown format using tree_to_mermaid.

Changed

  • Tree Exporter: Relax type hinting using TypeVar for clone_tree.

  • Tree Helper: Accept Iterable instead of List for custom_style attribute of yield_tree and print_tree.

  • Misc: Fix docstring for better presentation of code vs variable vs normal text.

0.12.5 - 2023-09-26

Added

  • Utility Groot: Add test cases.

Fixed

  • Tree Exporter: tree_to_pillow function to reference online font file instead of relative path.

0.12.4 - 2023-09-25

Added

  • Utility Groot: Add groot utility functions.

0.12.3 - 2023-09-17

Changed

  • Clearer documentation, fixed docstring phrasing and spelling.

  • Clearer error messages, standardized error messages.

0.12.2 - 2023-09-12

Changed

  • Tree Plot: Reingold Tilford Algorithm code for succinctness and docstring.

0.12.1 - 2023-09-11

Fixed

  • Tree Plot: Reingold Tilford Algorithm to handle cases of negative x-coordinates with adjustment parameter.

0.12.0 - 2023-09-09

Changed

  • Tree/DAG Constructor, Tree/DAG Exporter: Make pandas optional dependency.

Fixed

  • Misc: Fixed Calendar workflow to throw error when to_dataframe method is called on empty calendar.

  • Tree/DAGNode Exporter, Tree Helper, Tree Search: Relax type hinting using TypeVar.

0.11.0 - 2023-09-08

Added

  • Tree Helper: Pruning tree to allow pruning by prune_path and max_depth.

  • Tree Plot: Implement Enhanced Reingold Tilford Algorithm to retrieve (x, y) coordinates for a tree structure.

Changed

  • BaseNode/DAGNode: get_attr method to allow default return value.

Fixed

  • Utility Iterator: Relax type hinting using TypeVar.

0.10.3 - 2023-08-12

Added

  • Tree Constructor: add_path_to_tree, dataframe_to_tree, dataframe_to_tree_by_relation to allow custom node types that takes in constructor arguments.

Changed

  • Binary Tree: Able to accept node val of str type besides int type.

0.10.2 - 2023-08-11

Fixed

  • Tree Constructor: nested_dict_to_tree to throw TypeError if child_key is not list type.

0.10.1 - 2023-07-27

Added

  • [#71] Node: path_name to allow different node name of different dtypes; map everything to string type.

0.10.0 - 2023-07-15

Added

  • [#65] Tree Search: Implement find_relative_path to find relative path from node.

  • [#65] Utility Iterator: Implement zigzag_iter and zigzaggroup_iter Tree traversal methods.

0.9.5 - 2023-07-13

Added

  • Misc: Added init files, add link to discussions to README and pyproject, add sphinx coverage shortcuts.

Fixed

  • [#66] DAGNode/Node: Children constructor to allow Iterable types, fixed issue of lists being mutable.

  • [#67] Node: path_name to reduce number of recursive calls to root node for sep.

0.9.4 - 2023-06-18

Added

  • Tree Constructor: list_to_tree_by_relation and dataframe_to_tree_by_relation method to allow duplicate intermediate nodes (default is false).

  • DAG Exporter: Added node_shape parameter in dag_to_dot export function for easier way to customize node shape.

  • Misc: More test cases.

  • Misc: Added security instructions on how to raise vulnerabilities.

  • Misc: Added Calendar workflow to documentation.

Changed

  • Tree Constructor: add_dict_to_tree_by_name method rename argument from path_attrs to name_attrs.

  • Misc: Modified contributing instructions.

Fixed

  • Tree Exporter: tree_to_dot to handle cases when not all nodes have edge_attr.

  • DAG Exporter: dag_to_dot to perform dictionary copy to prevent style from being overridden for child nodes.

  • Tree Constructor: dataframe_to_tree to handle case when path column is not the first column.

0.9.3 - 2023-05-28

Changed

  • Tree Constructor: Relax type hint to Iterable instead of List for list_to_tree and list_to_tree_by_relation methods.

Fixed

  • Node: Fix error message when trees have different sep.

0.9.2 - 2023-04-09

Added

  • Node: Added show method to print tree to console.

  • Workflow Calendar: Tree use case with calendar implementation.

0.9.1 - 2023-03-30

Changed

  • Node: Added sep parameter to constructor instead of using getter and setter methods to set sep.

0.9.0 - 2023-03-29

Added

  • Tree Modifier: Ability to copy/shift nodes with full path in from_paths for faster search performance, added with_full_path parameter.

Changed

  • Tree Modifier: Enforced paths in to_paths to be full path for faster search performance.

  • Tree Modifier: Faster creation of intermediate parent nodes in to_paths.

  • Tree Modifier: Better handling of sep in paths by performing string replacement at the start.

  • Tree Modifier: Check and throw error for invalid parameters, case when node is meant to be deleted but copy=True.

Fixed

  • Tree Modifier: Fix issue trailing sep differing in from_paths and to_paths which should not throw error.

0.8.4 - 2023-03-24

Added

  • Tree Search: Implement find_child and find_children to find single child or multiple children based on user-defined condition.

Changed

  • Tree and DAG Constructor: Reduce reliance on numpy package, only reject None attributes when creating tree from DataFrame (previously it rejects [None]).

  • Tree Helper: Get difference between two trees reduce reliance on numpy package, enhance test cases.

  • Tree Search: Renamed find_children to find_child_by_name for clarity.

  • Misc: Fix README for Windows installation.

0.8.3 - 2023-03-16

Changed

  • Workflow: Misc refactor and update log statements.

  • Misc: Fix coverage report.

0.8.2 - 2023-03-16

Changed

  • Misc: Type checking to remove optional requirement for mypy.

  • Misc: Shift .flake8, .mypy.ini, and pytest.ini files to pyproject.toml.

0.8.1 - 2023-03-10

Fixed

  • Tree Modifier: Fix issue of sep of tree differing from the sep in from_paths and to_paths.

0.8.0 - 2023-03-10

Added

  • Misc: Type checking with mypy, added type checks to pre-commit hooks.

Changed

  • DAGNode: go_to method to be consistent with List[List[DAGNode]] type.

Fixed

  • Tree Exporter: Exception handling in yield_tree if node_name_or_path is not found.

  • Workflow: Exception handling in prioritizing item/list if item/list is not the correct tree depth.

  • Workflow: Exception handling in removing item/list if item/list is not found.

0.7.4 - 2023-02-27

Fixed

  • Tree Constructor: Fixed pandas SettingwithCopyWarning when performing dataframe operations.

0.7.3 - 2023-02-25

Added

  • Tree Exporter: Fixed print_tree checking attributes with hasattr to handle cases of null or 0 value attributes, add more test cases.

  • Misc: Added more description to Contributing.

0.7.2 - 2023-02-18

Added

  • Tree Exporter: Added node_shape parameter in tree_to_dot export function for easier way to customize node shape.

0.7.1 - 2023-02-18

Added

  • BaseNode/Node: Added go_to BaseNode method to travel from one node to another node from the same tree.

  • DAGNode: Added go_to DAGNode method to travel from one node to another node from the same DAG.

0.7.0 - 2023-02-18

Added

  • Tree Modifier: Accept merge_leaves type of modification, enhance documentation to provide more examples and illustrations.

0.6.10 - 2023-01-23

Fixed

  • Tree Constructor: str_to_tree accept prefixes to support unicode characters in node names.

0.6.9 - 2023-01-22

Added

  • Tree Construct: str_to_tree to construct tree from tree string.

0.6.8 - 2023-01-14

Fixed

  • Tree Exporter: tree_to_dot to perform dictionary copy to prevent style from being overridden for child nodes.

0.6.7 - 2023-01-09

Changed

  • Binary Tree: Changed BNode to BinaryNode, and construct method list_to_btree to list_to_binarytree.

0.6.6 - 2022-12-15

Added

  • Tree Exporter: Export print_tree output to image using Pillow package.

0.6.5 - 2022-12-07

Added

  • Tree Modifier: Shift/copy nodes able to shift node-only and delete the children (backwards-compatible).

0.6.4 - 2022-11-16

Fixed

  • BNode: Minor fix on rollback functionality when original children includes None.

0.6.3 - 2022-11-15

Added

  • DAGNode: Rollback functionality to original state when there is error setting parent and children (backwards-compatible).

Changed

  • BaseNode, BNode, DAGNode: Refactor by abstracting checks.

Fixed

  • BaseNode: Fix rollback logic to handle failure in pre-assign checks and reassigning same child / parent.

  • BNode: Fix issue of reassigning children shifting existing child from right to left.

0.6.2 - 2022-11-15

Changed

  • Tree Modifier: Shorter logging messages.

0.6.1 - 2022-11-14

Changed

  • Tree Modifier: Handle shifting/copying that removes intermediate layer (backwards-compatible).

0.6.0 - 2022-11-13

Added

  • BaseNode: Rollback functionality to original state when there is error setting parent and children (backwards-compatible).

  • BaseNode and DAGNode: Type hints.

  • BNode: Node class for Binary Tree.

  • BTree Constructor: From list.

  • BNode Iterator: Level-Order Iterator.

  • Misc: Add Tips and Tricks to documentation (List Directory).

Fixed

  • DAGNode: Fix issue of duplicate parent constructor creating duplicate children.

0.5.5 - 2022-11-12

Added

  • Misc: More docstring examples.

  • Misc: More test cases.

Fixed

  • Tree Modifier: Fix issue with merge_children argument not working as expected.

0.5.4 - 2022-11-12

Added

  • BaseNode: Add sort() to sort children.

  • Node: Made more extendable with pre-/post-assign checks.

  • Misc: Add Tips and Tricks to documentation (Extending Nodes).

  • Misc: More test cases.

Fixed

  • Tree Search: Type hints.

0.5.3 - 2022-11-11

Added

  • DAG and Tree Exporter: More customizations allowed on edges.

  • Add Tips and Tricks to documentation (Weighted Trees, Merging Trees).

Fixed

  • Tree Modifier: Fix issue with merge_children argument not working as expected.

0.5.2 - 2022-11-10

Fixed

  • Tree Constructor: Fix issue dataframe_to_tree_by_relation unable to find parent node.

0.5.1 - 2022-11-09

Added

  • Misc: Clean codes and documentation.

0.5.0 - 2022-11-09

Added

  • Misc: Clean codes and documentation.

Changed

  • Tree Exporter: Printing tree to group multiple arguments together.

  • DAG and Tree Exporter: Export to dot able to plot multiple disjointed trees/dags, rename bgcolor to bg_colour.

0.4.6 - 2022-11-09

Added

  • Tree Constructor: From DataFrame of parent-child columns.

Changed

  • Tree Exporter: Printing tree to define node name or path, and default to const style.

  • Tree Constructor: Rename list_to_tree_tuples to list_to_tree_by_relation.

  • Tree Constructor: Remove parameter sep for nested_dict_to_tree.

0.4.5 - 2022-11-08

Changed

  • Tree Exporter: Printing tree with added ability to omit null attributes.

0.4.4 - 2022-11-08

Fixed

  • Tree Constructor: Handle adding attributes that are array-like - add array even when one of the items is null.

0.4.3 - 2022-11-08

Added

  • Node: Print format for BaseNode.

0.4.2 - 2022-11-08

Fixed

  • Tree Constructor: For list of tuples, handle cases where parent name is None.

0.4.1 - 2022-11-07

Fixed

  • Tree Constructor: Handle adding attributes that are array-like - error in drop_duplicate() and pd.isnull().

0.4.0 - 2022-11-07

Added

  • Tree Constructor: From list of tuples of parent-child.

0.3.3 - 2022-11-07

Added

  • DAG Exporter: To list, nested dictionary, pandas DataFrame.

Changed

  • BaseNode and DAGNode: Modify docstring.

  • Tree Exporter: Support Nodes with same name.

  • Tree Modifier: Modify docstring.

  • Utility Iterator: Modify docstring.

0.3.2 - 2022-11-07

Fixed

  • Tree Exporter: Fix edge direction error.

0.3.1 - 2022-11-07

Added

  • Tree and DAG Exporter: More customizations for Node to dot and DAGNode to dot.

0.3.0 - 2022-11-05

Added

  • DAG Constructor: From list, nested dictionary, pandas DataFrame.

  • Utility Iterator: DAG traversal methods.

Changed

  • Tree Exporter and DAG Exporter: More customizations for Node to dot and DAGNode to dot.

0.2.0 - 2022-11-03

Added

  • Node: DAGNode for creating DAG graph.

  • Tree Exporter: Support Node to dot which can export to png, svg, jpeg, dot files.

  • DAG Exporter: Support DAGNode to dot.

0.1.0 - 2022-11-01

Added

  • Node: Node and BaseNode.

  • Tree Constructor: From list, nested dictionary, pandas DataFrame.

  • Tree Exporter: To list, nested dictionary, pandas DataFrame.

  • Tree Helper: Cloning, pruning trees, get difference between two trees.

  • Tree Modifier: Shift and copy nodes within tree and between trees.

  • Tree Search: Find single or multiple nodes based on name, attribute, or custom criteria.

  • Utility Iterator: Tree traversal methods.

  • Workflow To Do App: Tree use case with to-do list implementation.