Metadata-Version: 1.1
Name: django-modelqueryform
Version: 3.0
Summary: App for generating forms allowing users to build model queries
Home-page: https://github.com/ckirby/django-modelqueryform
Author: Chaim Kirby
Author-email: chaim.kirby@gmail.com
License: BSD
Description: =====================
        django-modelqueryform
        =====================
        
        .. image:: https://badge.fury.io/py/django-modelqueryform.png
            :target: https://badge.fury.io/py/django-modelqueryform
        
        .. image:: https://travis-ci.org/ckirby/django-modelqueryform.png?branch=master
            :target: https://travis-ci.org/ckirby/django-modelqueryform
        
        .. image:: https://coveralls.io/repos/ckirby/django-modelqueryform/badge.png?branch=master
            :target: https://coveralls.io/r/ckirby/django-modelqueryform?branch=master
        
        **django-modelqueryform** is a flexible app that helps you build Q object generating forms.
        
        It is a great tool if you want you users to be able to do filtered searches against your models.
        
        Project
        -------
        
        The project can be found at https://github.com/ckirby/django-modelqueryform
        
        Documentation
        -------------
        
        The full documentation is at https://django-modelqueryform.readthedocs.org.
        
        Requirements
        ------------
        
        * Django 1.11+
        * Python 3.4+
        
           
        Features
        --------
            
        * Useable default FormFields for ModelFields that:
        
            * Have `.choices` defined or are inherently made of choices (ie. `BooleanField` and `NullBooleanField`)
            * Are represented as numeric types (eg. `IntegerField`, `FloatField`, etc.)
            * Text backed fields need code written to handle them. That is easy though, because:
         
        * Creation of FormFields, Q objects, and User readable query terms are completely customizable. You can target ModelFields:
        
            * By name (If the field has specific requirements)
            * By field type (Use the same widget or Q object builder for all `CharField`\ s)
            
        * Can follow Model relationships or treat relationship fields as `.choices`
        * Provides a new Field and Widget (`RangeField`, `RangeWidget`). These allow users to generate a `__gte`, `__lte` pair for the orm, optionally also including an `__isnull`
        
            * RangeField
                
                * Dynamically generates min and max boundaries. (Aggregate `Min` and `Max` on the model field)
                * If `null=True` on the ModelField allows user to indicate if they want to include null values in the query
            
            * RangeWidget
                
                * Returns a `MultiWidget` with 2 `NumberInput` widgets (with min and max attributes)         
             
Keywords: django-modelqueryform
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
