Installation

Official releases

Official releases are available from PyPI. You can install it using the pip:

pip install django-mptt

You can also download the .zip distribution file and unpack it. Inside is a script named setup.py. Enter this command:

python setup.py install

…and the package will install automatically.

Development version

Alternatively, you can get the latest source from our git repository:

git clone git://github.com/django-mptt/django-mptt.git django-mptt

Add the resulting folder to your PYTHONPATH or symlink the mptt directory inside it into a directory which is on your PYTHONPATH, such as your Python installation’s site-packages directory.

You can verify that the application is available on your PYTHONPATH by opening a Python interpreter and entering the following commands:

>>> import mptt
>>> mptt.__version__
'0.14.0'

When you want to update your copy of the source code, run git pull from within the django-mptt directory.

Caution

The development version may contain bugs which are not present in the release version and introduce backwards-incompatible changes.

If you’re tracking master, keep an eye on the recent Commit History before you update your copy of the source code.

Adding MPTT to an existing model

If you are converting an existing model (one that already has rows in the database) to use MPTT, the tree fields will be added with a default of 0 by the Django migration. After running migrate you need to rebuild the tree so that all the MPTT fields get correct values:

python manage.py shell
>>> from myapp.models import MyModel
>>> MyModel.objects.rebuild()

If you need to do this inside a data migration, import and register the model manually — Django’s historical model proxy doesn’t carry the MPTT manager:

from django.db import migrations
from mptt.models import MPTTModel, TreeForeignKey

def rebuild_tree(apps, schema_editor):
    # Re-register the real model so the MPTT manager is available.
    MyModel = apps.get_model('myapp', 'MyModel')
    from mptt import register
    register(MyModel)
    MyModel.objects.rebuild()

class Migration(migrations.Migration):
    dependencies = [('myapp', '0001_initial')]
    operations = [migrations.RunPython(rebuild_tree, migrations.RunPython.noop)]