Metadata-Version: 2.1
Name: lxtree
Version: 0.1.0
Summary: Package to draw tree structures (tree linux command style)
Home-page: https://github.com/salpreh/lxtree
Author: salpreh
Author-email: salva.perez46@gmail.com
License: MIT License
Description: # lxtree
        
        [![PyPI version](https://badge.fury.io/py/lxtree.svg)](https://badge.fury.io/py/lxtree)
        [![PyPI version](https://img.shields.io/github/license/salpreh/lxtree.svg)](https://img.shields.io/github/license/salpreh/lxtree.svg)
        
        **Package to draw tree structures (tree linux command style)**
        
        ---
        ## Basic usage
        Build the tree structure using `TreeNode`s. A `TreeNode` can contain other `TreeNode`s
        to represent the tree. When builded you car get a string representation of it,
        or get string of a sub-tree using some child as root.
        
        ### Code samples
        ```py
        from lxtree import TreeNode
        
        
        # Creating root
        root = TreeNode('root')
        
        # Adding a list of nodes
        root.children = [TreeNode('branch1'), TreeNode('branch3')]
        
        # Insert node
        root.insert_child(TreeNode('branch2'), 1)
        
        # Appending to a branch 1 by index
        root[0].append_child(TreeNode('branch11'))
        
        # Using index to assign children to branch11
        root[0][0] = [TreeNode('leaf111'), TreeNode('leaf112')]
        
        # Use `set_children` to add nodes as argv
        root[1].set_children(TreeNode('leaf21'), TreeNode('leaf22'), TreeNode('leaf23'))
        
        # Print tree
        print(root)
        ```
        
        ##### Creating all structure at once
        ```py
        root = TreeNode('root').set_children(
          TreeNode('branch1').append_child(
              TreeNode('branch11').set_children(
                  TreeNode('leaf111'),
                  TreeNode('leaf112')
              )
          ),
          TreeNode('branch2').set_children(
              TreeNode('leaf21'),
              TreeNode('leaf22'),
              TreeNode('leaf23')
          ),
          TreeNode('branch3')
        )
        
        print(root)
        ```
        ##### Creating the tree from a dict
        ```py
        tree_data = {
          'root': {
              'branch1': {
                'branch11': {
                  'leaf111': None,
                  'leaf112': None
                }
              },
              'branch2': {
                'leaf21': None,
                'leaf22': None,
                'leaf23': None
              },
              'branch3': None
          }
        }
        
        print(TreeNode.tree_from_dict(tree_data))
        ```
        #### Output
        <img src="https://raw.githubusercontent.com/salpreh/lxtree/master/assets/sample_tree.png" alt="tree_output">
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
