Skip to main content

Utilities for implementing Modified Preorder Tree Traversal with your Django Models and working with trees of Model instances.

Project description

This project is currently unmaintained

Alternatives to django-mptt include:

  • django-treebeard includes a MPTT implementation (called nested set), but the state of maintenance is unclear.

  • Maybe you do not need MPTT, especially when using newer databases. See django-tree-queries for an implementation using recursive Common Table Expressions (CTE). See the announcement blog post.

django-mptt

Utilities for implementing Modified Preorder Tree Traversal with your Django Models and working with trees of Model instances.

Build Status

Project home: https://github.com/django-mptt/django-mptt/

Documentation: https://django-mptt.readthedocs.io/

Discussion group: https://groups.google.com/forum/#!forum/django-mptt-dev

What is Modified Preorder Tree Traversal?

MPTT is a technique for storing hierarchical data in a database. The aim is to make retrieval operations very efficient.

The trade-off for this efficiency is that performing inserts and moving items around the tree is more involved, as there’s some extra work required to keep the tree structure in a good state at all times.

Here are a few articles about MPTT to whet your appetite and provide details about how the technique itself works:

What is django-mptt?

django-mptt is a reusable Django app which aims to make it easy for you to use MPTT with your own Django models.

It takes care of the details of managing a database table as a tree structure and provides tools for working with trees of model instances.

Requirements

  • Python 3.6+

  • A supported version of Django (currently 2.2+)

Feature overview

  • Simple registration of models - fields required for tree structure will be added automatically.

  • The tree structure is automatically updated when you create or delete model instances, or change an instance’s parent.

  • Each level of the tree is automatically sorted by a field (or fields) of your choice.

  • New model methods are added to each registered model for:

    • changing position in the tree

    • retrieving ancestors, siblings, descendants

    • counting descendants

    • other tree-related operations

  • A TreeManager manager is added to all registered models. This provides methods to:

    • move nodes around a tree, or into a different tree

    • insert a node anywhere in a tree

    • rebuild the MPTT fields for the tree (useful when you do bulk updates outside of django)

  • Form fields for tree models.

  • Utility functions for tree models.

  • Template tags and filters for rendering trees.

  • Admin classes for visualizing and modifying trees in Django’s administration interface.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_mptt-0.15.0.tar.gz (69.6 kB view details)

Uploaded Source

Built Distribution

django_mptt-0.15.0-py3-none-any.whl (115.7 kB view details)

Uploaded Python 3

File details

Details for the file django_mptt-0.15.0.tar.gz.

File metadata

  • Download URL: django_mptt-0.15.0.tar.gz
  • Upload date:
  • Size: 69.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.25.0

File hashes

Hashes for django_mptt-0.15.0.tar.gz
Algorithm Hash digest
SHA256 0df19d5a55f34e73df58ee03fbe0d91807493de4bd3a09f6eb00fc62920035d9
MD5 c1936fa0baecd659a5222ff1736550ea
BLAKE2b-256 651406b0b8d5413831b89a84ca1ca9845d42ded74d03ee6d0145fe16672297a6

See more details on using hashes here.

File details

Details for the file django_mptt-0.15.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_mptt-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2574c014b102a41c642be5921f59356b8437fc83c9866d97644c6a0c5dc8ccc1
MD5 04db9b21be35b7d1df5e745ee955a1b9
BLAKE2b-256 d4e785cc45375893907a9fa09dde8eb36446ae553b32a78317afb30a209aef91

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page