README.rst

wagtailmodelchooser

Overview

Wagtail chooser panel generator for generic Django models.

It elegantly completes wagtail.contrib.modeladmin and allows a simple selection of any model instance anywhere in the Wagtail admin.

Requirements

• Python (3.4, 3.5, 3.6, 3.7)
• Django (1.11, 2.0, 2.1)
• Wagtail (2.2, 2.3)

Installation

Install using pip.

$ pip install wagtailmodelchooser

Example

The most simple usecase, without any customization.

from wagtailmodelchooser.edit_handlers import register_chooser_for_model

ItemChooserPanel = register_chooser_for_model(Item)

For more advanced examples, please refer to the documentation.

Testing

Install testing requirements.

$ pip install -r requirements.txt

Run with runtests.

$ ./runtests.py

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox globally, and then simply run:

$ tox

Documentation

To build the documentation, you’ll need to install mkdocs.

$ pip install mkdocs

To preview the documentation:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build the documentation:

$ mkdocs build