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

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

Uploaded Source

Built Distribution

django_formidable-0.13.0-py2-none-any.whl (65.6 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for django-formidable-0.13.0.tar.gz
Algorithm Hash digest
SHA256 5a079cbc8998f4b55cafbb2c6412b32d9f0a9fef6d2c5ec6b63cf9e4c577e928
MD5 da6220cf60a8b9a95c2644c7dd4fb3fc
BLAKE2b-256 44b2ad017499014c654eb9cce59f40ec77a683e3a507fb0c1a026a16b10da131

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_formidable-0.13.0-py2-none-any.whl
Algorithm Hash digest
SHA256 85271960be072e11aabba34ded24453ce05964948779f6c95fa0323623b56c80
MD5 1728e702a1164b1d9c63e94bcfaefee7
BLAKE2b-256 987df44dba67b9b5b7e4020a30d8e756aff0d0930a9488f053b6ee9a37c73cf7

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