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/peopledoc/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

See the Deprecation timeline document for more information on deprecated versions.

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

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.2.1.tar.gz (59.1 kB view details)

Uploaded Source

Built Distribution

django_formidable-1.2.1-py2-none-any.whl (60.4 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for django-formidable-1.2.1.tar.gz
Algorithm Hash digest
SHA256 530cd4d421ba8421bdb9749a4e83b6bb4051f02ad461032e9a50b64c953bf4ab
MD5 5f6cf54c439400acb9a3c6e9de797902
BLAKE2b-256 eca06b7e12e5e746293add1dcfec984d14752fc2429e14d3af865127a8508654

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_formidable-1.2.1-py2-none-any.whl
Algorithm Hash digest
SHA256 56ca7a13fe09820bc76bc298c2c1cf8c1d99bcc8a88b5630e3594b9397770322
MD5 deb569ca6278eb172efb4b463f19d278
BLAKE2b-256 f54dd0226b7257bbc6531062d2de2c6911651f6a9566e7ae6b38d524cdd9cd71

See more details on using hashes here.

Provenance

Supported by

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