Skip to content

Commit 980ae90

Browse files
authored
Update README.md
1 parent 5dc93df commit 980ae90

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
11
# typeform-python
22
TypeForm API wrapper written in python.
3+
4+
## Installing
5+
```
6+
pip install git+git://github.com/GearPlug/typeform-python.git
7+
```
8+
9+
## Requirements
10+
- requests
11+
12+
13+
## EndPoints
14+
- base: The base endpoint response contains information about the API. It is useful for testing or making sure you have access.
15+
- forms: The form endpoint is the main endpoint that you will be dealing with. It is the endpoint you use to create new typeforms. You have parameters to set the title, webhook URL and of course, the fields. The form endpoint will also return you a hash of URLs that you can use to distribute your typeform or delete it.
16+
- images: Due to existing constraints, we cannot process all images on the fly when creating typeforms containing the 'Picture Choice' question type. Therefore, we provide an endpoint for creating images for Picture Choices before creating your typeform.
17+
- designs: A design is what you see when you load your typeform. It contains information that is related to the styling of your typeform.
18+
- urls: The url endpoint creates a new URL linking to a typeform.

0 commit comments

Comments
 (0)