![No Maintenance Intended](https://camo.githubusercontent.com/155a25be7a26e4b1e74b3dfbdc18516d5055080fdc7510dd3af02e5f6e0a7152/687474703a2f2f756e6d61696e7461696e65642e746563682f62616467652e737667)
Pythonic library for typeform.io API.
First you'll need an API Key, you can get yours here.
Then you just have to define put it on a env variable called TYPEFORMIO_API_TOKEN
and py-typeformio will use it.
Also, you can define it on your code when initialize the BuildAPI:
(...)
buildapi = BuildAPI(api_token='XXX')
(...)
Example:
from typeformio.Design import Design
from typeformio.Form import Form
from typeformio.BuildAPI import BuildAPI
buildapi = BuildAPI(user_agent='My Awesome app')
design = Design(buildapi)
design.colors['question'] = '#FFFFFF'
design.colors['button'] = '#069ACB'
design.colors['answer'] = '#CEDBF0'
design.colors['background'] = '#292929'
design_json = design.generateDesign()
design_id = design_json['id']
form = Form(buildapi, 'Probando', 'http://vidimensional.es/hook',
design_id=design_id)
form.addShortTextField("What's your name?")
form.addYesNoField("Do you like Boardgames?")
form.addDropdownField('Which is you favourite boardgame?',
choices=['King Of Tokyo',
'Tigris and Eufrates',
'Carcassonne'])
form.addPictureChoiceField('Who is you favourite author?',
choices=[
('https://cf.geekdo-images.com/images/pic511133_t.jpg', 'Richard Garfield'),
('https://cf.geekdo-images.com/images/pic472979_t.jpg', 'Reiner Knizia'),
('https://cf.geekdo-images.com/images/pic820214_t.jpg', 'Klaus-Jürgen Wrede') ])
json_response = form.generateForm()
This will generate a form like this.
You can define your own user agent when initialize BuildAPI.
(...)
buildapi = BuildAPI(user_agent='My Awesome app')
(...)
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
max_characters |
The maximum number of characters the respondent can type as an answer. |
- |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
choices |
Array of choice objects with the choices that the respondent can select |
[] |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
choices |
Array of choice objects with the choices that the respondent can select. |
[] |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
choices |
Array of choice objects with the choices that the respondent can select |
[] |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
choices |
Array of choice objects with the choices that the respondent can select. |
[] |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
Argument |
Description |
Default |
Required |
question |
The main question text for the field. |
- |
Yes |
description |
The description (or sub-text) that appears below the main question text (in a smaller font size). |
- |
No |
required |
Decides if the field is mandatory. |
False |
No |
tags |
An array of tags as strings. |
[] |
|
ref |
A unique reference for the field. |
- |
No |
http://docs.typeform.io/