Skip to main content

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

Project description

===========
django-mptt
===========

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

.. image:: https://secure.travis-ci.org/django-mptt/django-mptt.png?branch=master
:alt: Build Status
:target: https://travis-ci.org/django-mptt/django-mptt

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

Documentation: http://django-mptt.github.io/django-mptt/

Discussion group: http://groups.google.com/group/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:

* `Trees in SQL`_
* `Storing Hierarchical Data in a Database`_
* `Managing Hierarchical Data in MySQL`_

.. _`Trees in SQL`: http://www.ibase.ru/devinfo/DBMSTrees/sqltrees.html
.. _`Storing Hierarchical Data in a Database`: http://www.sitepoint.com/print/hierarchical-data-database


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 2.7 or 3.2+
* A supported version of Django (currently 1.8+)

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

Uploaded Source

Built Distribution

django_mptt-0.8.1-py2.py3-none-any.whl (72.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-mptt-0.8.1.tar.gz.

File metadata

  • Download URL: django-mptt-0.8.1.tar.gz
  • Upload date:
  • Size: 194.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-mptt-0.8.1.tar.gz
Algorithm Hash digest
SHA256 d6e2db566e88c5fe39ec0bde8b1d9bf21298e36a23b7da9c6d401a122397e0b2
MD5 c215f8ea39b80ad20dcb80944ee4898d
BLAKE2b-256 e1099f048c325033a050b3b989f1fada7541956e4f7660b9c3dce4afe45f8999

See more details on using hashes here.

File details

Details for the file django_mptt-0.8.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_mptt-0.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fc364e900bb22e7462a25c31f4b35ad8fa856aedaf42daf42d8a3e3b80a94614
MD5 b15486a09365d041013d71f207b1d0d4
BLAKE2b-256 b449def3700406af4356a3c8c45022719df5cda01d51f78946225bff958ede3d

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