Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrewingram/django-extra-views

Django's class-based generic views are awesome, let's have more of them.
https://github.com/andrewingram/django-extra-views

django

Last synced: 1 day ago
JSON representation

Django's class-based generic views are awesome, let's have more of them.

Awesome Lists containing this project

README 

        
|build| |codecov| |docs-status|



Django Extra Views - The missing class-based generic views for Django

========================================================================



Django-extra-views is a Django package which introduces additional class-based views

in order to simplify common design patterns such as those found in the Django

admin interface.



Supported Python and Django versions: Python 3.6+, Django 2.2-5.1,

see `tox.ini `_ for an up-to-date list.



Full documentation is available at `read the docs`_.



.. _read the docs: https://django-extra-views.readthedocs.io/



.. |build| image:: https://github.com/AndrewIngram/django-extra-views/workflows/Tests/badge.svg

    :target: https://github.com/AndrewIngram/django-extra-views/

    :alt: Build Status



.. |codecov| image:: https://codecov.io/github/AndrewIngram/django-extra-views/coverage.svg?branch=master

    :target: https://codecov.io/github/AndrewIngram/django-extra-views?branch=master

    :alt: Coverage Status



.. |docs-status| image:: https://readthedocs.org/projects/django-extra-views/badge/?version=latest

    :target: https://django-extra-views.readthedocs.io/

    :alt: Documentation Status



.. installation-start



Installation

------------



Install the stable release from pypi (using pip):



.. code-block:: sh



    pip install django-extra-views



Or install the current master branch from github:



.. code-block:: sh



    pip install -e git://github.com/AndrewIngram/django-extra-views.git#egg=django-extra-views



Then add ``'extra_views'`` to your ``INSTALLED_APPS``:



.. code-block:: python



    INSTALLED_APPS = [

        ...

        'extra_views',

        ...

    ]



.. installation-end



.. features-start



Features

--------



- ``FormSet`` and ``ModelFormSet`` views - The formset equivalents of

  ``FormView`` and ``ModelFormView``.

- ``InlineFormSetView`` - Lets you edit a formset related to a model (using

  Django's ``inlineformset_factory``).

- ``CreateWithInlinesView`` and ``UpdateWithInlinesView`` - Lets you edit a

  model and multiple inline formsets all in one view.

- ``GenericInlineFormSetView``, the equivalent of ``InlineFormSetView`` but for

  ``GenericForeignKeys``.

- Support for generic inlines in ``CreateWithInlinesView`` and

  ``UpdateWithInlinesView``.

- Support for naming each inline or formset in the template context with

  ``NamedFormsetsMixin``.

- ``SortableListMixin`` - Generic mixin for sorting functionality in your views.

- ``SearchableListMixin`` - Generic mixin for search functionality in your views.

- ``SuccessMessageMixin`` and ``FormSetSuccessMessageMixin`` - Generic mixins

  to display success messages after form submission.



.. features-end



Still to do

-----------



Add support for pagination in ModelFormSetView and its derivatives, the goal

being to be able to mimic the change_list view in Django's admin. Currently this

is proving difficult because of how Django's MultipleObjectMixin handles pagination.



.. quick-examples-start



Quick Examples

--------------



FormSetView

^^^^^^^^^^^^^^^^^^^^^^^



Define a :code:`FormSetView`, a view which creates a single formset from

:code:`django.forms.formset_factory` and adds it to the context.



.. code-block:: python



    from extra_views import FormSetView

    from my_forms import AddressForm



    class AddressFormSet(FormSetView):

        form_class = AddressForm

        template_name = 'address_formset.html'



Then within ``address_formset.html``, render the formset like this:



.. code-block:: html



    

      ...

      {{ formset }}

      ...

      

    



ModelFormSetView

^^^^^^^^^^^^^^^^^^^^



Define a :code:`ModelFormSetView`, a view which works as :code:`FormSetView`

but instead renders a model formset using

:code:`django.forms.modelformset_factory`.



.. code-block:: python



    from extra_views import ModelFormSetView



    class ItemFormSetView(ModelFormSetView):

        model = Item

        fields = ['name', 'sku']

        template_name = 'item_formset.html'



CreateWithInlinesView or UpdateWithInlinesView

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



Define :code:`CreateWithInlinesView` and :code:`UpdateWithInlinesView`,

views which render a form to create/update a model instance and its related

inline formsets. Each of the :code:`InlineFormSetFactory` classes use similar

class definitions as the :code:`ModelFormSetView`.



.. code-block:: python



    from extra_views import CreateWithInlinesView, UpdateWithInlinesView, InlineFormSetFactory



    class ItemInline(InlineFormSetFactory):

        model = Item

        fields = ['sku', 'price', 'name']



    class ContactInline(InlineFormSetFactory):

        model = Contact

        fields = ['name', 'email']



    class CreateOrderView(CreateWithInlinesView):

        model = Order

        inlines = [ItemInline, ContactInline]

        fields = ['customer', 'name']

        template_name = 'order_and_items.html'



    class UpdateOrderView(UpdateWithInlinesView):

        model = Order

        inlines = [ItemInline, ContactInline]

        fields = ['customer', 'name']

        template_name = 'order_and_items.html'



Then within ``order_and_items.html``, render the formset like this:



.. code-block:: html



    

      ...

      {{ form }}



      {% for formset in inlines %}

        {{ formset }}

      {% endfor %}

      ...

      

    



.. quick-examples-end



Contributing

------------



Pull requests are welcome. To run all tests locally, setup a virtual environment and run



.. code-block:: sh



    tox



Before committing, use ``pre-commit`` to check all formatting and linting



.. code-block:: sh



    pip install pre-commit

    pre-commmit install



This will automatically run ``black``, ``isort`` and ``flake8`` before the commit is accepted.