Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gearplug/surveymonkey-python
Python wrapper for SurveyMonkey API
https://github.com/gearplug/surveymonkey-python
api-wrapper python3
Last synced: 3 days ago
JSON representation
Python wrapper for SurveyMonkey API
- Host: GitHub
- URL: https://github.com/gearplug/surveymonkey-python
- Owner: GearPlug
- License: mit
- Created: 2018-10-03T14:45:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T17:12:56.000Z (8 months ago)
- Last Synced: 2024-10-05T14:15:22.182Z (about 1 month ago)
- Topics: api-wrapper, python3
- Language: Python
- Size: 43.9 KB
- Stars: 13
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# surveymonkey-python
Python wrapper for SurveyMonkey API
## Installing
```
pip install surveymonkey-python
```
## Usage
- Instantiate client
```
from client import Client
# If you do not have access_token, run
client=Client(
client_id=CLIENT_ID, client_secret=CLIENT_SECRET, redirect_uri=REDIRECT_URI, access_token=None)
# If you have access_token, run
client=Client(
client_id=CLIENT_ID, client_secret=CLIENT_SECRET, redirect_uri=REDIRECT_URI, access_token=ACCESS_TOKEN)
```
- OAuth (instantiate client with `access_token = None`)
1- Get authorization URL `client.get_authorization_url()`
2- Extract `code` from the URL and send it as an argument in `client.exchange_code(code)`
3- Remove the token from the response obtained and send it as an argument in `client.set_access_token(token)`
- Functionality methods, they refer to methods that make calls to the different endpoints of the SurveyMonkey API,
the use is quite simple:
`client.method(args)`
e.g. `client.get_survey_pages(survey_id)`
where `survey_id` represent the id of the survey.
# TODO
- Response Counts and Trends endpoints
- Contacts and Contact Lists endpoints
- Translations for Multilingual Surveys endpoints
- Collectors and Invite Messages endpoints
- Benchmarks endpoints
- Organizations endpoint
- Errors endpoint
## 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/surveymonkey-python).
#### If you want to add yourself some functionality to the wrapper:
1. Fork it ( https://github.com/GearPlug/surveymonkey-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