Metadata-Version: 1.1
Name: form-designer
Version: 0.17.1
Summary: Form Designer
Home-page: https://github.com/feincms/form_designer/
Author: Matthias Kestenholz
Author-email: mk@feinheit.ch
License: BSD License
Description: =================================================
        Form Designer - a simple form designer for Django
        =================================================
        
        .. image:: https://travis-ci.org/feincms/form_designer.png?branch=master
           :target: https://travis-ci.org/feincms/form_designer
        
        This form designer does not try to offer every last configuration possibility
        of Django's forms, just through the administration interface instead of
        directly in Python code. Instead, it strives to be a tool which everyone can
        use right away, without the need for long explanations.
        
        It offers a small set of predefined input fields such as:
        
        * Text fields (One line and multi line widgets possible)
        * E-mail address fields
        * Checkboxes
        * Dropdowns
        * Radio Buttons
        * Multiple selection checkboxes
        * Hidden input fields
        
        Every field can optionally be declared mandatory, default values and help texts
        are available too. That's it.
        
        By default, form data is sent by e-mail to a freely definable e-mail address
        and stored in the database (a XLSX export of saved submissions is provided too).
        It is possible to add your own actions as well.
        
        
        Installing the form designer
        ============================
        
        Install the package using pip::
        
            $ pip install form_designer
        
        Setting up the form designer
        ============================
        
        - Add ``"form_designer"`` and ``"admin_ordering"`` to ``INSTALLED_APPS``.
        - Run ``./manage.py migrate form_designer``
        - Go into Django's admin panel and add one or more forms with the fields you
          require. Also select at least one action in the configuration options
          selectbox, most often you'd want to select both the "E-mail" and the
          "Save form submission" option. After saving once, you'll see additional
          fields belonging to the selected configuration options, in this case
          a field for entering an e-mail address where the submission results should
          be sent to.
        
        If you're using the form designer with FeinCMS_, the content type can be
        imported from ``form_designer.contents.FormContent``. Otherwise, your
        code should use the following methods (the code would probably reside in
        a view)::
        
            # Somehow fetch the form_designer.models.Form instance:
            instance = ...
        
            # Build the form class:
            form_class = instance.form()
        
            # Standard form processing:
            if request.method == "POST":
                form = form_class(request.POST)
        
                if form.is_valid():
                    # Do what you want, or run the configured processors:
                    result = instance.process(form, request)
        
                    # Maybe there's something useful in here:
                    pprint(result)
        
                    ...
            else:
                form = form_class()
        
            return render(...)
        
        
        Adding custom actions
        =====================
        
        Custom actions can be added by appending them to
        ``Form.CONFIG_OPTIONS``::
        
            from form_designer.models import Form
        
            def do_thing(model_instance, form_instance, request, config, **kwargs):
                pass
        
            def do_validate(form_instance, data):
                pass
        
            Form.CONFIG_OPTIONS.append(
                ("do_thing", {
                    "title": _("Do a thing"),
                    "form_fields": lambda form: [
                        ("optional_form_field", forms.CharField(
                            label=_("Optional form field"),
                            required=False,
                            # validators...
                            # help_text...
                        )),
                    ],
                    "process": do_thing,
                    "validate": do_validate,
                })
            )
        
        The interesting part if the ``do_thing`` callable. It currently receives
        four arguments, however you should also accept ``**kwargs`` to support
        additional arguments added in the future:
        
        - ``model_instance``: The ``Form`` model instance
        - ``form_instance``: The dynamically generated form instance
        - ``request``: The current HTTP request
        - ``config``: The config options (keys and values defined through
          ``form_fields``; for example the ``email`` action defines an ``email``
          char field, and accesses its value using ``config["email"]``.
        
        
        ReCaptcha
        =========
        
        To enable [ReCaptcha](http://www.google.com/recaptcha) install
        [django-recaptcha](https://github.com/praekelt/django-recaptcha) and add
        `captcha` to your `INSTALLED_APPS`. This will automatically add a ReCaptcha
        field to the form designer. For everything else read through the
        django-recaptcha readme.
        
        
        Override field types
        ====================
        
        Define ``FORM_DESIGNER_FIELD_TYPES`` in your settings file like::
        
            FORM_DESIGNER_FIELD_TYPES = "your_project.form_designer_config.FIELD_TYPES"
        
        In ``your_project.form_designer_config.py`` something like::
        
            from django import forms
            from django.utils.translation import gettext_lazy as _
        
            FIELD_TYPES = [
                {"type": "text", "verbose_name": _("text"), "field": forms.CharField},
                {"type": "email", "verbose_name": _("e-mail address"), "field": forms.EmailField},
            ]
        
        
        Visit these sites for more information
        ======================================
        
        * form_designer: https://github.com/feincms/form_designer
        * FeinCMS: http://www.feinheit.ch/labs/feincms-django-cms/
        * feincms3: https://feincms3.readthedocs.io/
        
        .. _django-admin-ordering: https://github.com/matthiask/django-admin-ordering
        .. _FeinCMS: https://feincms-django-cms.readthedocs.io/
        
Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development
