bump: v0.25.1, update docs

kayjan · kayjan · commit db0f33f71222 · 2025-02-28T19:59:17.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.25.0] - 2025-02-25
+## [0.25.1] - 2025-02-28
 ### Added:
 - Tree Exporter: `vprint_tree` to have same arguments as `vyield_tree`, add more test cases.
 - Tree Exporter: `hprint_tree` to support multiline node name, alias, and border style.
@@ -741,7 +741,8 @@ ignore null attribute columns.
 - Utility Iterator: Tree traversal methods.
 - Workflow To Do App: Tree use case with to-do list implementation.
 
-[Unreleased]: https://github.com/kayjan/bigtree/compare/0.25.0...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/0.25.1...HEAD
+[0.25.1]: https://github.com/kayjan/bigtree/compare/0.25.0...0.25.1
 [0.25.0]: https://github.com/kayjan/bigtree/compare/0.24.0...0.25.0
 [0.24.0]: https://github.com/kayjan/bigtree/compare/0.23.1...0.24.0
 [0.23.1]: https://github.com/kayjan/bigtree/compare/0.23.0...0.23.1
diff --git a/bigtree/__init__.py b/bigtree/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.25.0"
+__version__ = "0.25.1"
 
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag
diff --git a/bigtree/tree/export/stdout.py b/bigtree/tree/export/stdout.py
@@ -495,6 +495,19 @@ def hprint_tree(
         - a -+     \\- e
              \\- c
 
+        **Border**
+
+        >>> hprint_tree(root, style="rounded", border_style="rounded")
+                            ╭───────╮
+                  ╭───────╮╭┤   d   │
+                 ╭┤   b   ├┤╰───────╯
+        ╭───────╮│╰───────╯│╭───────╮
+        │   a   ├┤         ╰┤   e   │
+        ╰───────╯│          ╰───────╯
+                 │╭───────╮
+                 ╰┤   c   │
+                  ╰───────╯
+
         **Printing to a file**
         >>> import io
         >>> output = io.StringIO()
@@ -537,7 +550,7 @@ def hyield_tree(
     max_depth: int = 0,
     intermediate_node_name: bool = True,
     style: Union[str, Iterable[str], constants.BaseHPrintStyle] = "const",
-    border_style: Optional[Union[str, Iterable[str], constants.BorderStyle]] = "const",
+    border_style: Optional[Union[str, Iterable[str], constants.BorderStyle]] = None,
     strip: bool = True,
 ) -> List[str]:
     """Yield tree in horizontal orientation to console, starting from `tree`.
@@ -642,6 +655,20 @@ def hyield_tree(
         - a -+     \\- e
              \\- c
 
+        **Border**
+
+        >>> result = hyield_tree(root, style="rounded", border_style="rounded")
+        >>> print("\\n".join(result))
+                            ╭───────╮
+                  ╭───────╮╭┤   d   │
+                 ╭┤   b   ├┤╰───────╯
+        ╭───────╮│╰───────╯│╭───────╮
+        │   a   ├┤         ╰┤   e   │
+        ╰───────╯│          ╰───────╯
+                 │╭───────╮
+                 ╰┤   c   │
+                  ╰───────╯
+
     Args:
         tree (Node): tree to print
         alias (str): node attribute to use for node name in tree as alias to `node_name`, if present.
@@ -976,19 +1003,19 @@ def vprint_tree(
 
         **Custom Styles**
 
-        >>> from bigtree import ANSIVPrintStyle, ANSIBorderStyle
-        >>> vprint_tree(root, style=ANSIVPrintStyle, border_style=ANSIBorderStyle, strip=True)
-                `---`
-                | a |
-                `-+-`
-             /----+-----\\
-           `-+-`      `-+-`
-           | b |      | c |
-           `-+-`      `---`
-          /--+---\\
-        `-+-`  `-+-`
-        | d |  | e |
-        `---`  `---`
+        >>> from bigtree import RoundedVPrintStyle, RoundedBorderStyle
+        >>> vprint_tree(root, style=RoundedVPrintStyle, border_style=RoundedBorderStyle, strip=True)
+                ╭───╮
+                │ a │
+                ╰─┬─╯
+             ╭────┴─────╮
+           ╭─┴─╮      ╭─┴─╮
+           │ b │      │ c │
+           ╰─┬─╯      ╰───╯
+          ╭──┴───╮
+        ╭─┴─╮  ╭─┴─╮
+        │ d │  │ e │
+        ╰───╯  ╰───╯
 
         **Printing to a file**
         >>> import io
@@ -1207,20 +1234,20 @@ def vyield_tree(
 
         **Custom Styles**
 
-        >>> from bigtree import ANSIVPrintStyle, ANSIBorderStyle
-        >>> result = vyield_tree(root, style=ANSIVPrintStyle, border_style=ANSIBorderStyle, strip=True)
+        >>> from bigtree import RoundedVPrintStyle, RoundedBorderStyle
+        >>> result = vyield_tree(root, style=RoundedVPrintStyle, border_style=RoundedBorderStyle, strip=True)
         >>> print("\\n".join(result))
-                `---`
-                | a |
-                `-+-`
-             /----+-----\\
-           `-+-`      `-+-`
-           | b |      | c |
-           `-+-`      `---`
-          /--+---\\
-        `-+-`  `-+-`
-        | d |  | e |
-        `---`  `---`
+                ╭───╮
+                │ a │
+                ╰─┬─╯
+             ╭────┴─────╮
+           ╭─┴─╮      ╭─┴─╮
+           │ b │      │ c │
+           ╰─┬─╯      ╰───╯
+          ╭──┴───╮
+        ╭─┴─╮  ╭─┴─╮
+        │ d │  │ e │
+        ╰───╯  ╰───╯
 
     Args:
         tree (Node): tree to print
diff --git a/docs/bigtree/tree/export.md b/docs/bigtree/tree/export.md
@@ -28,8 +28,8 @@ While exporting to another data type, methods can take in arguments to determine
 |------------------------|-------------------------------------|-----------------------|------------|---------------------------------------|-------------------------------------------------------|
 | `print_tree`           | Yes with `attr_list` or `all_attrs` | Yes                   | No         | No                                    | Tree style                                            |
 | `yield_tree`           | No, returns node                    | Yes                   | No         | No                                    | Tree style                                            |
-| `hprint_tree`          | No                                  | Yes                   | No         | Yes, by hiding intermediate node name | Tree style                                            |
-| `hyield_tree`          | No                                  | Yes                   | No         | Yes, by hiding intermediate node name | Tree style                                            |
+| `hprint_tree`          | No                                  | Yes                   | No         | Yes, by hiding intermediate node name | Tree style, border style                              |
+| `hyield_tree`          | No                                  | Yes                   | No         | Yes, by hiding intermediate node name | Tree style, border style                              |
 | `vprint_tree`          | No                                  | Yes                   | No         | Yes, by hiding intermediate node name | Tree style, border style                              |
 | `vyield_tree`          | No                                  | Yes                   | No         | Yes, by hiding intermediate node name | Tree style, border style                              |
 | `tree_to_newick`       | Yes with `attr_list`                | No                    | No         | Yes, by hiding intermediate node name | Length separator and attribute prefix and separator   |
diff --git a/docs/gettingstarted/demo/tree.md b/docs/gettingstarted/demo/tree.md
@@ -339,12 +339,12 @@ Construct nodes with attributes. *DataFrame* can contain either <mark>path colum
 
 ### 1. Print Tree
 
-After tree is constructed, it can be viewed by printing to console using `show` or `hshow` method directly,
-for vertical and horizontal orientation respectively.
-Alternatively, the `print_tree` or `hprint_tree` method can be used.
+After tree is constructed, it can be viewed by printing to console using `show`, `hshow`, or `vshow` method directly,
+for compact, horizontal, and vertical orientation respectively.
+Alternatively, the `print_tree`, `hprint_tree`, or `vprint_tree` method can be used.
 
 ```python hl_lines="8 15"
-from bigtree import Node, print_tree, hprint_tree
+from bigtree import Node, print_tree, hprint_tree, vprint_tree
 
 root = Node("a", alias="alias-a", age=90, gender="F")
 b = Node("b", age=65, gender="M", parent=root)
@@ -363,17 +363,31 @@ hprint_tree(root) # (2)!
 #      ┌─ b ─┤
 # ─ a ─┤     └─ e
 #      └─ c
+
+vprint_tree(root) # (3)!
+#         ┌───┐
+#         │ a │
+#         └─┬─┘
+#      ┌────┴─────┐
+#    ┌─┴─┐      ┌─┴─┐
+#    │ b │      │ c │
+#    └─┬─┘      └───┘
+#   ┌──┴───┐
+# ┌─┴─┐  ┌─┴─┐
+# │ d │  │ e │
+# └───┘  └───┘
 ```
 
 1. Alternatively, `root.show()` can be used
 2. Alternatively, `root.hshow()` can be used
+3. Alternatively, `root.vshow()` can be used
 
 Other customizations for printing are also available, such as:
 
 - Printing alias instead of node name, if present
 - Printing subtree
 - Printing tree with attributes
-- Different built-in or custom style
+- Different built-in or custom style and border style
 
 === "Alias"
     ```python hl_lines="1"
@@ -572,6 +586,7 @@ Below is the table of operations available to `BaseNode` and `Node` classes.
 |-------------------------------------------------|------------------------------------------------------------|--------------------------------------------|
 | Visualize tree (only for `Node`)                | `root.show()`                                              | None                                       |
 | Visualize tree (horizontally) (only for `Node`) | `root.hshow()`                                             | None                                       |
+| Visualize tree (vertically) (only for `Node`)   | `root.vshow()`                                             | None                                       |
 | Get node information                            | `root.describe(exclude_prefix="_")`                        | [('name', 'a')]                            |
 | Find path from one node to another              | `root.go_to(node_e)`                                       | [Node(/a, ), Node(/a/b, ), Node(/a/b/e, )] |
 | Add child to node                               | `root.append(Node("j"))`                                   | None                                       |
diff --git a/docs/home/tree.md b/docs/home/tree.md
@@ -53,7 +53,7 @@ For **Tree** implementation, there are 9 main components.
 - Plot tree using matplotlib (optional dependency)
 
 ## [**🔨 Exporting Tree**](../bigtree/tree/export.md)
-- Print to console, in vertical or horizontal orientation
+- Print to console, in compact, vertical, or horizontal orientation
 - Export to *Newick string notation*, *dictionary*, *nested dictionary*, *pandas DataFrame*, or *polars DataFrame*
 - Export tree to *dot* (can save to .dot, .png, .svg, .jpeg files)
 - Export tree to *Pillow* (can save to .png, .jpg)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-__version__ = "0.25.0"`
	`1`	`+__version__ = "0.25.1"`
`2`	`2`
`3`	`3`	`from bigtree.binarytree.construct import list_to_binarytree`
`4`	`4`	`from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag`