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, 3.6

  • Django compatibility : Django 1.10, 1.11

  • Django REST Framework : Compatible from the version 3.5.4 to 3.8.x ; django-formidable is incompatible with the 3.9.x series.

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

Uploaded Source

File details

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

File metadata

  • Download URL: django-formidable-3.0.0.tar.gz
  • Upload date:
  • Size: 30.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.12

File hashes

Hashes for django-formidable-3.0.0.tar.gz
Algorithm Hash digest
SHA256 b5a1590a65a353403c365bc1933de5d049a27b8f6d40ce156dc4541127a86045
MD5 f521f61797be90f5c5d1cb1703ab78dd
BLAKE2b-256 795d41cfc67a1c1b42918dd13451d35627c57401fb8ee792a4f473c44b3129f7

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