Tree Implementation and Methods for Python, integrated with list, dictionary, pandas and polars DataFrame.
Project description
Big Tree Python Package
Tree Implementation and Methods for Python, integrated with list, dictionary, pandas and polars DataFrame.
It is pythonic, making it easy to learn and extendable to many types of workflows.
Related Links:
- Documentation
- GitHub
- Community
- Package
- Articles
-
If you want to support bigtree,
Components
There are 3 segments to Big Tree consisting of Tree, Binary Tree, and Directed Acyclic Graph (DAG) implementation.
For Tree implementation, there are 12 main components.
- 🌺 Node
BaseNode, extendable classNode, BaseNode with node name attribute
- 🎄 Tree
Tree, wrapper aroundNode, providing high-level APIs to build, iterate, query, and export the entire tree structure
- ✨ Constructing Tree
- From
Node, using parent and children constructors - From str, using tree display or Newick string notation
- From list, using paths or parent-child tuples
- From nested dictionary, using path-attribute key-value pairs or recursive structure
- From pandas DataFrame, using paths or parent-child columns
- From polars DataFrame, using paths or parent-child columns
- From interactive UI
- From rich trees
- Add nodes to existing tree using path string
- Add nodes and attributes to existing tree using dictionary, pandas DataFrame, or polars DataFrame, using path
- Add only attributes to existing tree using dictionary, pandas DataFrame, or polars DataFrame, using node name
- From
- ➰ Traversing Tree
- Pre-Order Traversal
- Post-Order Traversal
- Level-Order Traversal
- Level-Order-Group Traversal
- ZigZag Traversal
- ZigZag-Group Traversal
- 🧩 Parsing Tree
- Get common ancestors between nodes
- Get path from one node to another node
- 📝 Modifying Tree
- Copy nodes from location to destination
- Shift nodes from location to destination
- Shift and replace nodes from location to destination
- Copy nodes from one tree to another
- Copy and replace nodes from one tree to another
- 📌 Querying Tree
- Filter tree using Tree Query Language
- 🔍 Tree Search
- Find multiple nodes based on name, partial path, relative path, attribute value, user-defined condition
- Find single nodes based on name, partial path, relative path, full path, attribute value, user-defined condition
- Find multiple child nodes based on user-defined condition
- Find single child node based on name, user-defined condition
- 🔧 Helper Function
- Cloning tree to another
Nodetype - Get subtree (smaller tree with different root)
- Prune tree (smaller tree with same root)
- Get difference between two trees
- Cloning tree to another
- 📊 Plotting Tree
- Enhanced Reingold Tilford Algorithm to retrieve (x, y) coordinates for a tree structure
- Plot tree using matplotlib (optional dependency)
- 🔨 Exporting Tree
- Print to console, in 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)
- Export tree to Mermaid Flowchart (can display on .md)
- Export tree to Pyvis Network (can display interactive .html)
- ✔️ Workflows
- Sample workflows for tree demonstration!
For Binary Tree implementation, there are 4 main components. Binary Node inherits from Node, so the components in Tree implementation are also available in Binary Tree.
- 🌿 Node
BinaryNode, Node with binary tree rules
- 🎄 Binary Tree
BinaryTree, wrapper aroundBinaryNode, providing high-level APIs to build, iterate, query, and export the entire tree structure
- ✨ Constructing Binary Tree
- From list, using flattened list structure
- ➰ Traversing Binary Tree
- In-Order Traversal
For Directed Acyclic Graph (DAG) implementation, there are 6 main components.
- 🌼 Node
DAGNode, extendable class for constructing Directed Acyclic Graph (DAG)
- 🎄 DAG
DAG, wrapper aroundDAGNode, providing high-level APIs to build, export, and iterate the entire DAG
- ✨ Constructing DAG
- From list, containing parent-child tuples
- From nested dictionary
- From pandas DataFrame
- ➰ Traversing DAG
- Generic traversal method
- 🧩 Parsing DAG
- Get possible paths from one node to another node
- 🔨 Exporting DAG
- Export to list, dictionary, or pandas DataFrame
- Export DAG to dot (can save to .dot, .png, .svg, .jpeg files)
Installation
bigtree requires Python 3.10+. There are two ways to install bigtree, with pip (recommended) or conda.
a) Installation with pip
Basic Installation
To install bigtree, run the following line in command prompt:
$ pip install bigtree
Installing optional dependencies
bigtree have a number of optional dependencies, which can be installed using "extras" syntax.
$ pip install 'bigtree[extra_1, extra_2]'
Examples of extra packages include:
all: include all optional dependenciesimage: for exporting tree to imagematplotlib: for plotting treespandas: for pandas methodspolars: for polars methodsquery: for tree query methodsrich: for printing tree in rich formatvis: for pyvis visualisation
For image extra dependency, you may need to install more plugins.
$ brew install gprof2dot # for MacOS
$ conda install graphviz # for Windows
b) Installation with conda
To install bigtree with conda, run the following line in command prompt:
$ conda install -c conda-forge bigtree
Star History
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bigtree-1.3.1.tar.gz.
File metadata
- Download URL: bigtree-1.3.1.tar.gz
- Upload date:
- Size: 1.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.3 cpython/3.14.3 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a22a0ecd9b0abb283f4a1515370dbf1ec93adee70746767272e2c49d7af9f407
|
|
| MD5 |
9ae9395deb841da3effab3f768ef408a
|
|
| BLAKE2b-256 |
d1aeac72cebb51b4d3180e44b20a52634c682b66bf7eaf7a0db2236db419f324
|
File details
Details for the file bigtree-1.3.1-py3-none-any.whl.
File metadata
- Download URL: bigtree-1.3.1-py3-none-any.whl
- Upload date:
- Size: 114.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.3 cpython/3.14.3 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c8b766b00188c532d3499bfd9e9666b357428db507fc701f088031a0d5c614d5
|
|
| MD5 |
d137cf1f4387f77e9149ccd0d21b3019
|
|
| BLAKE2b-256 |
b3726102c002b1b4c04f8c5ed870f102f576a5fbd6a41cdb3e49ed339aa95dfe
|
