Pupil Cloud API Client

Pupil Cloud API

API version: 1.0
Package version: 1.0.1

Requirements.

Python 2.7 and 3.4+

Installation & Usage

Pip install

Install directly using:

pip install pupilcloud

pip install git+https://github.com/pupil-labs/pupil-cloud-client-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/pupil-labs/pupil-cloud-client-python.git)

Then import the package:

import pupilcloud

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pupilcloud

Getting Started

Please follow the installation procedure and then run the following:

from pupilcloud import Api, ApiException

api = pupilcloud.Api(api_key="API_KEY", host="https://api.cloud.pupil-labs.com")

try:
    # Returns the current logged in user based on auth token
    data = api.get_profile().result
    print(data)
except ApiException as e:
    print("Exception when calling AuthApi->get_profile: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.cloud.pupil-labs.com

Class	Method	HTTP request	Description
AuthApi	get_profile	GET /auth/profile	Returns the current logged in user based on auth token
LabelsApi	delete_label	DELETE /labels/{label_id}	Delete a label
LabelsApi	get_label	GET /labels/{label_id}	Returns a label with {label_id}
LabelsApi	get_labels	GET /labels/	List all labels
LabelsApi	patch_label	PATCH /labels/{label_id}	Update a label
LabelsApi	post_label	POST /labels/	Create a new label
RecordingsApi	delete_recording	DELETE /recordings/{recording_id}	Delete a recording
RecordingsApi	download_recording_file	GET /recordings/{recording_id}/files/{filename}	Download a recording's file
RecordingsApi	download_recording_zip	GET /recordings/{recording_id}.zip	Download recording files as a zip file
RecordingsApi	download_recordings_zip	GET /recordings.zip	Download multiple recordings in zip archive
RecordingsApi	get_recording	GET /recordings/{recording_id}	Returns a recording with {recording_id}
RecordingsApi	get_recording_events	GET /recordings/{recording_id}/events	List recording events
RecordingsApi	get_recording_files	GET /recordings/{recording_id}/files	List recording files
RecordingsApi	get_recordings	GET /recordings/	List all recordings
RecordingsApi	patch_recording	PATCH /recordings/{recording_id}	Update a recording
TemplatesApi	delete_template	DELETE /templates/{template_id}	Delete a template
TemplatesApi	get_template	GET /templates/{template_id}	Returns a template with {template_id}
TemplatesApi	get_templates	GET /templates/	List all templates
TemplatesApi	patch_template	PATCH /templates/{template_id}	Update a template
TemplatesApi	post_template	POST /templates/	Create a new template
WearersApi	delete_wearer	DELETE /wearers/{wearer_id}	Delete a wearer
WearersApi	get_wearer	GET /wearers/{wearer_id}	Returns a wearer with {wearer_id}
WearersApi	get_wearers	GET /wearers/	List all wearers
WearersApi	patch_wearer	PATCH /wearers/{wearer_id}	Update a wearer
WearersApi	post_wearer	POST /wearers/	Create a new wearer

pfaion/pupil-cloud-client-python

Pupil Cloud API Client

Requirements.

Installation & Usage

Pip install

Setuptools

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

api_key

Author