Form.io JSON-data API


License
MIT
Install
pip install formio-data==0.1.0.dev17

Documentation

formio-data (Python)

Form.io (JSON) data API for Python.

For information about Form.io, see Form.io homepage

Introduction

python-formio-data is a Python package, which loads and transforms Form.io Builder JSON and Form JSON into usable Python objects. It's main aim is to provide easy access to a Form its components/fields, also captured as Python objects, which makes this API very versatile and usable.

Notes about terms:

  • "Builder" could be read/seen as "Builder Form"
  • "Form" could be read/seen as "Form"
  • "Component" could be read/seen as "Field"

Features

  • Compatible with Python 3.3 and later
  • Constructor of the Builder and Form class, only requires the JSON and an optional language code for translations.
  • Get a Form object its Components/Fields as a usable object e.g. DateTime, Boolean, Dict (for select component) etc.
  • Open source (MIT License)

Installation

The source code is currently hosted on GitHub at: https://github.com/novacode-nl/python-formio-data

Binary installers for the latest released version are available at the Python package index

# PyPI
pip install formio-data

License

MIT

Contributing

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.

Usage examples

For more examples of usage, see the unit-tests.

>> from formiodata import Builder, Form
>>
# builder_json is a Form.io Builder JSON document (text/string)
# form_json is a Form.io Form JSON document (text/string)
>>
>> builder = Builder(builder_json)
>> form = Form(builder, form_json)

# Text Field (control)
>> print(form.data.firstname.label)
'First Name'

# Value as Python string too
>> print(form.data.firstname.value)
'Bob'

# Date (control)
>> print(form.data.birthday.label)
'Birthday'

# Value as Python Date object
>> print(form.data.birthday.value)
datetime.date(2009 10 16)

Unit tests

Run all unittests

From toplevel directory:

python -m unittest

Run component unittests

python -m unittest tests/test_component_*.py