https://github.com/mar10/nutree

A Python library for tree data structures with an intuitive, yet powerful API.
https://github.com/mar10/nutree

data-structures digraph graph hierarchy python tree treelib

Last synced: about 10 hours ago
JSON representation

A Python library for tree data structures with an intuitive, yet powerful API.

• Host: GitHub
• URL: https://github.com/mar10/nutree
• Owner: mar10
• License: mit
• Created: 2021-12-10T12:28:31.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-14T21:55:57.000Z (9 days ago)
• Last Synced: 2024-12-16T07:05:37.032Z (7 days ago)
• Topics: data-structures, digraph, graph, hierarchy, python, tree, treelib
• Language: Python
• Homepage: https://nutree.readthedocs.io
• Size: 3.21 MB
• Stars: 37
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ![logo](https://raw.githubusercontent.com/mar10/nutree/main/docs/nutree_48x48.png) nutree

[![Latest Version](https://img.shields.io/pypi/v/nutree.svg)](https://pypi.python.org/pypi/nutree/)

[![Tests](https://github.com/mar10/nutree/actions/workflows/tests.yml/badge.svg)](https://github.com/mar10/nutree/actions/workflows/tests.yml)

[![codecov](https://codecov.io/github/mar10/nutree/branch/main/graph/badge.svg?token=9xmAFm8Icl)](https://codecov.io/github/mar10/nutree)

[![License](https://img.shields.io/pypi/l/nutree.svg)](https://github.com/mar10/nutree/blob/main/LICENSE.txt)

[![Documentation Status](https://readthedocs.org/projects/nutree/badge/?version=latest)](http://nutree.readthedocs.io/)

[![Released with: Yabs](https://img.shields.io/badge/released%20with-yabs-yellowgreen)](https://github.com/mar10/yabs)

[![StackOverflow: nutree](https://img.shields.io/badge/StackOverflow-nutree-blue.svg)](https://stackoverflow.com/questions/tagged/nutree)

> _Nutree_ is a Python library for tree data structures with an intuitive,

> yet powerful, API.

**Nutree Facts**

Handle multiple references of single objects ('clones') 


Search by name pattern, id, or object reference 


Compare two trees and calculate patches 


Unobtrusive handling of arbitrary objects 


Save as DOT file and graphwiz diagram 


Nodes can be plain strings or objects 


(De)Serialize to (compressed) JSON 


Save as Mermaid flow diagram 


Different traversal methods 


Generate random trees 


Convert to RDF graph 


Fully type annotated 


Typed child nodes 


Pretty print 


Navigation 


Filtering 


**Example**

A simple tree, with text nodes

```py

from nutree import Tree, Node

tree = Tree("Store")

n = tree.add("Records")

n.add("Let It Be")

n.add("Get Yer Ya-Ya's Out!")

n = tree.add("Books")

n.add("The Little Prince")

tree.print()

```

```ascii

Tree<'Store'>

├─── 'Records'

│    ├─── 'Let It Be'

│    ╰─── "Get Yer Ya-Ya's Out!"

╰─── 'Books'

     ╰─── 'The Little Prince'

```

Tree nodes wrap the data and also expose methods for navigation, searching,

iteration, ...

```py

records_node = tree["Records"]

assert isinstance(records_node, Node)

assert records_node.name == "Records"

print(records_node.first_child())

```

```ascii

Node<'Let It Be', data_id=510268653885439170>

```

Nodes may be strings or arbitrary objects:

```py

alice = Person("Alice", age=23, guid="{123-456}")

tree.add(alice)

# Lookup nodes by object, data_id, name pattern, ...

assert isinstance(tree[alice].data, Person)

del tree[alice]

```

[Read the Docs](https://nutree.readthedocs.io/) for more.