API wrapper for Typeform written in Python
Project description
# typeform-python
TypeForm API wrapper written in python.
## Installing
```
pip install typeform-python
```
## Requirements
- requests
## Usage
### Simple access with API KEY
```
from typeform.client import Client
client = Client('API_KEY')
```
### Authorized Access
```
from typeform.client import Client
client = Client('TOKEN')
To get the TOKEN follow the documentation
https://developer.typeform.com/get-started/scopes/
```
Get form ID
```
client.get_form_uid('URL_FORM')
```
Get form information
```
client.get_form_information('UID, URL')
```
Get form stats
```
client.get_form_stats('UID, URL')
```
Get form questions
```
client.get_form_questions('UID, URL')
```
Get form metadata
```
client.get_form_metadata('UID, URL')
```
Get all forms
```
client.get_forms()
```
Create Webhook
```
client.create_webhook(url_webhook, tag_webhook, uid)
```
Delete Webhook
```
client.create_webhook(tag_webhook, uid)
```
View Webhook
```
client.create_webhook(tag_webhook, uid)
```
## TODO
- create_form
- Update_form
- delete_form
- get_custom_form_messages
- update_custom_messages
- create_image
- get_images_collection
- get_image
- delete_image
- get_image_by_size
- get_background_by_size
- get_choice_image_by_size
- create_theme
- get_themes
- update_themes
- delete_themes
TypeForm API wrapper written in python.
## Installing
```
pip install typeform-python
```
## Requirements
- requests
## Usage
### Simple access with API KEY
```
from typeform.client import Client
client = Client('API_KEY')
```
### Authorized Access
```
from typeform.client import Client
client = Client('TOKEN')
To get the TOKEN follow the documentation
https://developer.typeform.com/get-started/scopes/
```
Get form ID
```
client.get_form_uid('URL_FORM')
```
Get form information
```
client.get_form_information('UID, URL')
```
Get form stats
```
client.get_form_stats('UID, URL')
```
Get form questions
```
client.get_form_questions('UID, URL')
```
Get form metadata
```
client.get_form_metadata('UID, URL')
```
Get all forms
```
client.get_forms()
```
Create Webhook
```
client.create_webhook(url_webhook, tag_webhook, uid)
```
Delete Webhook
```
client.create_webhook(tag_webhook, uid)
```
View Webhook
```
client.create_webhook(tag_webhook, uid)
```
## TODO
- create_form
- Update_form
- delete_form
- get_custom_form_messages
- update_custom_messages
- create_image
- get_images_collection
- get_image
- delete_image
- get_image_by_size
- get_background_by_size
- get_choice_image_by_size
- create_theme
- get_themes
- update_themes
- delete_themes
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
typeform-python-0.1.tar.gz
(3.4 kB
view hashes)