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.6+ (with experimental support for python 3.2+ and PyPy)
* Django 1.4.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.

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

Uploaded Source

Built Distribution

django_mptt-0.7.4-py2.py3-none-any.whl (66.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for django-mptt-0.7.4.tar.gz
Algorithm Hash digest
SHA256 8e986aaf458aaf78c87dc316095cc4a951f3ec1d73f81b237107161fa3ea4ad0
MD5 7b74c105dde5ff7ca285b761e7487f99
BLAKE2b-256 7fadc6a84f96bf117fa6498ee8e6c9808717c687f68b2b83c46b1e42288df4a5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_mptt-0.7.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 581c40e15c668a3d91f6f3ab65136e0f48da9fb60d9784571f1a67bd858703dd
MD5 b198c399671bd49d98414d9628d8c81b
BLAKE2b-256 dca8fc4742a3ae2f11f487c54081ff0b240b893b10656bc2139eb04dfce5ddae

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