Metadata-Version: 1.1
Name: wagtail-modelchooser
Version: 2.2.2
Summary: Model choosers for Wagtail admin
Home-page: https://github.com/takeflight/wagtailmodelchooser/
Author: Tim Heap
Author-email: tim@takeflight.com.au
License: BSD License
Description: =====================
        Wagtail model chooser
        =====================
        
        A plugin for Wagtail that provides a ``ModelChooserPanel`` and ``ModelChooserBlock``
        for arbitrary models.
        
        Installing
        ==========
        
        Install using pip::
        
            pip install wagtail-modelchooser
        
        Then add it to your ``INSTALLED_APPS``:
        
        .. code-block:: python
        
            INSTALLED_APPS = [
                # ...
                'wagtailmodelchooser',
                # ...
            ]
        
        It works with Wagtail 2.2 and upwards.
        For older versions of Wagtail check previous versions of the package.
        
        Quick start
        ===========
        
        To enable the chooser for your model, you must register the model.
        For simple cases, decorate your model with ``@register_model_chooser``:
        
        .. code:: python
        
            from django.db import models
        
            from wagtailmodelchooser import register_model_chooser
        
        
            @register_model_chooser
            class Author(models.Model):
                name = models.CharField(max_length=255)
        
                def __str__(self):
                    # The ``str()`` of your model will be used in the chooser
                    return self.name
        
        You can then use either ``ModelChooserPanel`` in an edit handler definition,
        or ``ModelChooserBlock`` in a ``StreamField`` definition:
        
        .. code:: python
        
            from wagtail.wagtailcore.blocks import RichTextBlock
            from wagtail.wagtailcore.fields import StreamField
            from wagtail.wagtailcore.models import Page
            from wagtail.wagtailadmin.edit_handlers import FieldPanel, StreamFieldPanel
            from wagtailmodelchooser.blocks import ModelChooserBlock
            from wagtailmodelchooser.edit_handlers import ModelChooserPanel
        
            class Book(Page):
                name = models.CharField(max_length=255)
                author = models.ForeignKey(Author)
        
                content_panels = [
                    FieldPanel('name'),
                    ModelChooserPanel('author'),
                ]
        
            class ContentPage(Page):
                body = StreamField([
                    ('text', RichTextBlock()),
                    ('author', ModelChooserBlock('books.Author')),
                ])
        
                content_panels = [
                    StreamFieldPanel('body'),
                ]
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: BSD License
