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

You can find alternatives to django-mptt on Django Packages. Maybe you do not need MPTT, especially when using newer databases. See django-tree-queries for an implementation using recursive Common Table Expressions (CTE). Here’s its 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 are 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 that 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

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.17.0.tar.gz (71.4 kB view details)

Uploaded Source

Built Distribution

django_mptt-0.17.0-py3-none-any.whl (120.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for django_mptt-0.17.0.tar.gz
Algorithm Hash digest
SHA256 e2dca00536450b91bdc80d8fc1454993b84307728394ae42c72947fc09574d3d
MD5 3bb00771b45d67febea9f01fc4fb9f09
BLAKE2b-256 246790f48b70f854d24a0c73db2837fa63746ebf548ba2075c4c829cb25674a9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_mptt-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e77dd4b4d0de14f50239b0900def44c1d31403664ab3682b80b27fa1319fe7f0
MD5 2ee44429027d5b46c0ef240579e4c939
BLAKE2b-256 8d81ce5576765cea3cdb37c983400f76050194c354d55a3facf39561cf24adc2

See more details on using hashes here.

Supported by

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