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.11+ 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:

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

If you’re using django-grappelli, you will also need to add to include nested_admin.urls in your urlpatterns:

# Django 2+
urlpatterns = [
    # ...
    path('_nested_admin/', include('nested_admin.urls')),
]

# Django < 2
urlpatterns = [
    # ...
    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 pytest 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 --selenosis-driver=chrome to pytest or, if running with tox, running tox -- --selenosis-driver=chrome. See pytest --help for a complete list of the options available.

Contributing

This project uses webpack 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 npm run build to rebuild the static files.

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

Uploaded Source

Built Distribution

django_nested_admin-3.3.2-py2.py3-none-any.whl (386.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: django-nested-admin-3.3.2.tar.gz
  • Upload date:
  • Size: 345.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.2

File hashes

Hashes for django-nested-admin-3.3.2.tar.gz
Algorithm Hash digest
SHA256 7ec58af67107e6d7b2d0fd4fe03629eff8f7957c4aef5033c4700da1bd2d7870
MD5 5c0b77fc1a948078ef6366c2803700d3
BLAKE2b-256 eef2168d12a8f4e9ea74fb9ec0903e3778c04bdc66e6a35d73e8e441472356d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_nested_admin-3.3.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 386.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.2

File hashes

Hashes for django_nested_admin-3.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2e6706050057f5dc5664bc90d034d4ed9e3ae032ead6b063da9982c9e45ab7f3
MD5 6d8b7887a8793781a56dfb8c110e98b4
BLAKE2b-256 c4ae8e4335acec4cb1b390506bd9d42e278bf3db4d329fe383aaf4f752aece90

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