Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gearplug/typeform-python
TypeForm API wrapper written in python.
https://github.com/gearplug/typeform-python
api python typeform typeform-api-wrapper typeform-python wrapper wrapper-api
Last synced: 3 days ago
JSON representation
TypeForm API wrapper written in python.
- Host: GitHub
- URL: https://github.com/gearplug/typeform-python
- Owner: GearPlug
- License: mit
- Created: 2017-09-20T13:45:11.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T14:14:49.000Z (over 1 year ago)
- Last Synced: 2024-11-07T11:12:21.465Z (7 days ago)
- Topics: api, python, typeform, typeform-api-wrapper, typeform-python, wrapper, wrapper-api
- Language: Python
- Size: 33.2 KB
- Stars: 5
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typeform-python
TypeForm API wrapper written in python.
## Installing
```
pip install typeform-python
```
## Usage
```
from typeform.client import Client
client = Client('CLIENT_KEY', 'CLIENT_SECRET')
```
Get authorization url
```
url = client.authorization_url('REDIRECT_URI', ['forms:write', 'forms:read'])
```
Exchange the code for a token
```
token = client.exchange_code('REDIRECT_URI', 'CODE')
```
Set the token
```
client.set_access_token('TOKEN')
```
Get form ID
```
client.get_form_uid('FORM_URL')
```
Get form information
```
client.get_form_information('FORM_UID')
```
Get form questions
```
client.get_form_questions('FORM_UID')
```
Get form metadata
```
client.get_form_metadata('FORM_UID', 'SINCE', 'UNTIL')
```
Get all forms
```
client.get_forms()
```
Create Webhook
```
client.create_webhook('WEBHOOK_URL', 'WEBHOOK_TAG', 'FORM_UID')
```
View Webhook
```
client.view_webhook('WEBHOOK_TAG', 'FORM_UID')
```
Delete Webhook
```
client.delete_webhook('WEBHOOK_TAG', 'FORM_UID')
```
## Requirements
- requests
## 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
## Contributing
We are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.
#### You can report any bug you find or suggest new functionality with a new [issue](https://github.com/GearPlug/typeform-python).
#### If you want to add yourself some functionality to the wrapper:
1. Fork it ( https://github.com/GearPlug/typeform-python )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Adds my new feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request