Skip to main content

django-formidable is a full django application which allows you to create, edit, delete and use forms.

Project description

docs/source/_static/formidable-logo.png https://circleci.com/gh/novafloss/django-formidable.svg?style=svg&circle-token=6f273f564e1e44f702aef7c1d00baff74609c791

django-formidable is a full django application which allows you to create, edit, delete and use forms.

Warnings

  • Python Compatibility : Python 2.7, 3.5

  • Django compatibility : Django 1.8, 1.9, 1.10

_Note: python3.4 support has been dropped since django-formidable 0.12.0._

License

MIT License

Documentation

Latest version of the documentation: http://django-formidable.readthedocs.io/en/latest/

If you want to build the documentation locally, you can try to run one of the following:

$ make docs
$ tox -e docs

You can also browse the documentation locally, using the following, for example:

$ make docs serve-docs

Quick-Start

Install

$ pip install django-formidable

Configure

Define Roles

django-formidable allows access to a single form by different roles. The same form can thus be rendered in different ways. If you don’t need to handle multiple roles you must still define at least one default role.

Define a method which returns a list of formidable.accesses.AccessObject:

def get_roles(self):
    return [
        AccessObject(id='padawan', label='Padawan'),
        AccessObject(id='jedi', label='Jedi')
    ]

Fill the settings key:

FORMIDABLE_ACCESS_RIGHTS_LOADER = 'yourproject.access_rights.get_roles'

Get context

While accessing a form for a specific role, you need to provide a way in which to get the correct context to use.

request and kwargs are fetched from the view (self.request, self.kwargs)

def get_context(request, kwargs):
    return request.user.user_type

Next fill the setting key FORMIDABLE_CONTEXT_LOADER

FORMIDABLE_CONTEXT_LOADER = 'yourprojects.access_rights.get_context'

Define URLs

URLs are defined in formidable.urls. You can load them with the following line:

url(r'^api/', include('formidable.urls', namespace='formidable'))

By default, the views are not accessible, the permissions loaded are fully restrictive. To allow any access to the view fill your settings with

FORMIDABLE_DEFAULT_PERMISSION=['rest_framework.permissions.AllowAll']

To handle special permissions, please refer to the online documentation.

Project details


Release history Release notifications | RSS feed

This version

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-formidable-1.0.0.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

django_formidable-1.0.0-py2-none-any.whl (61.7 kB view details)

Uploaded Python 2

File details

Details for the file django-formidable-1.0.0.tar.gz.

File metadata

File hashes

Hashes for django-formidable-1.0.0.tar.gz
Algorithm Hash digest
SHA256 572e6789563ab9a7fbe45675cc6d0433ec559735e287420635cf6240e0d2a240
MD5 14bf4cdd08332248f1c478b5a28bdf21
BLAKE2b-256 8d0c2b09188092a16f44917519068c910e177a487a7cb002c1b44f4b590ade8b

See more details on using hashes here.

File details

Details for the file django_formidable-1.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for django_formidable-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 4e3e620c7c85e76f4effe25b92185a0e07ceed351187c55cb61e22d6417fd53d
MD5 12a1ea54e91e46168b40cbab072027f3
BLAKE2b-256 7110f6d1b5fedd934c6aa165e3a9452d7ea3f6cd66d1984d32a79353f983252e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page