django-treebeard

django-treebeard is a library that implements efficient tree implementations for the Django Web Framework, originally written by Gustavo Picón and licensed under the Apache License 2.0.

django-treebeard is:

• Flexible: Includes 4 different tree implementations with the same API:

  1. Adjacency List

  2. Materialized Path

  3. Nested Sets

  4. PostgreSQL Ltree (experimental)

• Fast: Optimized non-naive tree operations

• Easy: Uses Django’s Model inheritance to define your own models.

• Clean: Testable and well tested code base. Code test coverage is above 96%.

Overview

• Installation
  • Prerequisites
  • Installing
    • .deb packages
  • Configuration
• Tutorial
• Choosing a tree implementation
• Known Caveats
  • Updating objects
  • Inconsistent state
  • Overriding the default manager
  • Custom Managers

• Changelog

Reference

• API
  • Node
    • Node.delete()
    • Node.get_depth()
    • Node.is_child_of()
    • Node.is_descendant_of()
    • Node.is_sibling_of()
    • Node.is_root()
    • Node.is_leaf()
  • NodeManager
    • NodeManager.add_root()
    • NodeManager.add_child()
    • NodeManager.add_sibling()
    • NodeManager.move()
    • NodeManager.get_tree()
    • NodeManager.get_first_root_node()
    • NodeManager.get_last_root_node()
    • NodeManager.get_root_nodes()
    • NodeManager.get_ancestors()
    • NodeManager.get_children()
    • NodeManager.get_children_count()
    • NodeManager.get_descendants()
    • NodeManager.get_descendant_count()
    • NodeManager.get_first_child()
    • NodeManager.get_last_child()
    • NodeManager.get_first_sibling()
    • NodeManager.get_last_sibling()
    • NodeManager.get_prev_sibling()
    • NodeManager.get_next_sibling()
    • NodeManager.get_parent()
    • NodeManager.get_root()
    • NodeManager.get_siblings()
    • NodeManager.load_bulk()
    • NodeManager.dump_bulk()
    • NodeManager.get_descendants_group_count()
    • NodeManager.get_annotated_list()
    • NodeManager.get_annotated_list_qs()
• Materialized Path trees
  • MP_Node
    • MP_Node.steplen
    • MP_Node.alphabet
    • MP_Node.node_order_by
    • MP_Node.path
    • MP_Node.depth
    • MP_Node.numchild
    • MP_Node.move()
  • MP_NodeManager
    • MP_NodeManager.get_tree()
    • MP_NodeManager.add_root()
    • MP_NodeManager.add_child()
    • MP_NodeManager.add_sibling()
    • MP_NodeManager.find_problems()
    • MP_NodeManager.fix_tree()
    • MP_NodeManager.load_bulk()
  • MP_NodeQuerySet
  • Signals
    • path_updated
    • nodes_deleted
• Nested Sets trees
  • NS_Node
    • NS_Node.node_order_by
    • NS_Node.depth
    • NS_Node.lft
    • NS_Node.rgt
    • NS_Node.tree_id
    • NS_Node.get_tree()
  • NS_NodeManager
    • NS_NodeManager.find_problems()
  • NS_NodeQuerySet
  • Signals
    • gap_altered
    • tree_ids_incremented
    • subtree_moved
    • nodes_deleted
• Adjacency List trees
  • AL_Node
    • AL_Node.node_order_by
    • AL_Node.parent
    • AL_Node.sib_order
    • AL_Node.get_depth()
  • AL_NodeManager
• PostgreSQL Ltree trees (experimental)
  • LT_Node
    • LT_Node.node_order_by
    • LT_Node.path
    • LT_Node.add_root()
    • LT_Node.move()
    • LT_Node.get_tree()
  • LT_NodeManager
    • LT_NodeManager.add_child()
    • LT_NodeManager.add_sibling()
  • LT_NodeQuerySet
  • Signals
    • subtree_moved_right
    • subtree_moved
    • nodes_deleted
• Exceptions
  • InvalidPosition
  • InvalidMoveToDescendant
  • NodeAlreadySaved
  • PathOverflow
  • MissingNodeOrderBy

Additional features

• Admin
  • API
    • TreeAdmin
    • admin_factory()
  • Interface
    • Advanced Interface
    • Basic Interface
    • Model Detail Pages
    • Foreign keys and One-to-one relationships
• Forms
  • MoveNodeForm
  • movenodeform_factory()

Development

• Running the Test Suite
  • pytest
  • tox

Indices and tables

• Index

• Module Index

• Search Page