Merge pull request #90 from kayjan/v0.12.4

v0.12.4

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [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.
@@ -323,6 +327,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Utility Iterator: Tree traversal methods.
 - Workflow To Do App: Tree use case with to-do list implementation.
 
+[0.12.4]: https://github.com/kayjan/bigtree/compare/0.12.3...0.12.4
 [0.12.3]: https://github.com/kayjan/bigtree/compare/0.12.2...0.12.3
 [0.12.2]: https://github.com/kayjan/bigtree/compare/0.12.1...0.12.2
 [0.12.1]: https://github.com/kayjan/bigtree/compare/0.12.0...0.12.1

bigtree/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.12.3"
+__version__ = "0.12.4"
 
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag
@@ -60,6 +60,7 @@
     SearchError,
     TreeError,
 )
+from bigtree.utils.groot import speak_like_groot, whoami
 from bigtree.utils.iterators import (
     dag_iterator,
     inorder_iter,

bigtree/utils/groot.py

@@ -0,0 +1,19 @@
+def whoami() -> str:
+    """Groot utils
+
+    Returns:
+        (str)
+    """
+    return "I am Groot!"
+
+
+def speak_like_groot(sentence: str) -> str:
+    """Convert sentence into Groot langauge
+
+    Args:
+        sentence (str): Sentence to convert to groot language
+
+    Returns:
+        (str)
+    """
+    return " ".join([whoami() for _ in range(len(sentence.split()))])