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 : 3.6, 3.7, 3.8

  • Django compatibility : Django 2.2.

  • Django REST Framework : Compatible from the version 3.9.x to 3.10.x

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

This version

6.1.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-6.1.0.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

django_formidable-6.1.0-py3-none-any.whl (46.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-formidable-6.1.0.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.9

File hashes

Hashes for django-formidable-6.1.0.tar.gz
Algorithm Hash digest
SHA256 4fc883d7b34ecad42b10e572906a24d830a5ec299a9ea0de2c9d4ba75683b097
MD5 548fcfd97d2db28b068dc4ea95c6f7ef
BLAKE2b-256 c7d73ecc2e7fde60648282b21587c99c550ec4466112b4cd54d7cea2ec24723a

See more details on using hashes here.

Provenance

File details

Details for the file django_formidable-6.1.0-py3-none-any.whl.

File metadata

  • Download URL: django_formidable-6.1.0-py3-none-any.whl
  • Upload date:
  • Size: 46.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.9

File hashes

Hashes for django_formidable-6.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 104795c01f5df177c68ea490fc1c6770d9084b5e85534b419768c7038fef815b
MD5 48628e82a9bbe15e9a188db0a676e09b
BLAKE2b-256 c441c59e3c20ffa992e317858ea737dfb3a7579612bde6dba2d8a712fce22c6f

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