Skip to main content

Django admin classes that allow for nested inlines

Project description

build_badge docs_badge

django-nested-admin is a project that makes it possible to nest admin inlines (that is, to define inlines on InlineModelAdmin classes). It is compatible with Django 1.8+ and Python versions 2.7 and 3.4+ and works with or without Grappelli. When Grappelli is not installed it allows Grappelli-like drag-and-drop functionality.

Installation

The recommended way to install django-nested-admin is from PyPI:

pip install django-nested-admin

Alternatively, one can install a development copy of django-nested-admin from source:

pip install -e git+git://github.com/theatlantic/django-nested-admin.git#egg=django-nested-admin

If the source is already checked out, use setuptools to install:

python setup.py develop

Configuration

To use django-nested-admin in your project, "nested_admin" must be added to the INSTALLED_APPS in your settings and you must include nested_admin.urls in your django urlpatterns. django-grappelli is an optional dependency of django-nested-admin. If using Grappelli, make sure the appropriate version of Grappelli is installed for your version of Django.

# settings.py

INSTALLED_APPS = (
    # ...
    'nested_admin',
)

# urls.py

urlpatterns = patterns('',
    # ...
    url(r'^nested_admin/', include('nested_admin.urls')),
)

Example Usage

In order to use django-nested-admin, use the following classes in place of their django admin equivalents:

django.contrib.admin

nested_admin

ModelAdmin

NestedModelAdmin

InlineModelAdmin

NestedInlineModelAdmin

StackedInline

NestedStackedInline

TabularInline

NestedTabularInline

There is also nested_admin.NestedGenericStackedInline and nested_admin.NestedGenericTabularInline which are the nesting-capable versions of GenericStackedInline and GenericTabularInline in django.contrib.contenttypes.admin.

# An example admin.py for a Table of Contents app

from django.contrib import admin
import nested_admin

from .models import TableOfContents, TocArticle, TocSection

class TocArticleInline(nested_admin.NestedStackedInline):
    model = TocArticle
    sortable_field_name = "position"

class TocSectionInline(nested_admin.NestedStackedInline):
    model = TocSection
    sortable_field_name = "position"
    inlines = [TocArticleInline]

class TableOfContentsAdmin(nested_admin.NestedModelAdmin):
    inlines = [TocSectionInline]

admin.site.register(TableOfContents, TableOfContentsAdmin)

Testing

django-nested-admin has fairly extensive test coverage. The best way to run the tests is with tox, which runs the tests against all supported Django installs. To run the tests within a virtualenv run python runtests.py from the repository directory. The tests require a selenium webdriver to be installed. By default the tests run with phantomjs, but it is also possible to run the tests with the chrome webdriver by passing --selenium=chrome to runtests.py or, if running with tox, running tox -- --selenium=chrome. See runtests.py --help for a complete list of the options available.

Contributing

This project uses gulp, babel, browserify, and scss for building its javascript and css. To install the dependencies for the build process, run npm install from the root of the repository. You can then run gulp to rebuild the static files, or gulp watch when actively editing these files to detect changes and rebuild automatically.

License

The django code is licensed under the Simplified BSD License. View the LICENSE file under the root directory for complete license and copyright information.

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-nested-admin-3.0.5.tar.gz (209.9 kB view details)

Uploaded Source

Built Distribution

django_nested_admin-3.0.5-py2.py3-none-any.whl (234.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-nested-admin-3.0.5.tar.gz.

File metadata

File hashes

Hashes for django-nested-admin-3.0.5.tar.gz
Algorithm Hash digest
SHA256 6f80d35c06493c8c42bc948a5de129e77128d96076b26a8d12992680666a2020
MD5 2b1832af8b3a35d3fb9e7809ab73212e
BLAKE2b-256 97574f7cd3184a0e10878e52bcbb6e8f16d1d878eb4bc610afa6b4d5f8bf5421

See more details on using hashes here.

File details

Details for the file django_nested_admin-3.0.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_nested_admin-3.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 07bb7ba055e68ca9eeed374c1de327e8418ceec0441a38669a9686783eba50a8
MD5 6843c4cd82d17af81608b17c6cecf96a
BLAKE2b-256 52d8877ce78d7549e5dcc5d5ebbb3730d78a39231a26d836319cff4003c65614

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