Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 1.86 KB

source.md

File metadata and controls

37 lines (21 loc) · 1.86 KB

Classes and Methods of the Python client

vip_client currently contains 5 classes in vip_client.classes and 1 module in vip_client.utils.

Classes

vip_client.classes.VipSession

The most user-friendly class to interact with VIP. See the documentation here.

vip_client.classes.VipLauncher

A parent class of VipSession that implements everything needed to launch VIP applications on remote data sets. More information to come.

vip_client.classes.VipGirder

[Prototype] A VipLauncher implementation to launch VIP application on Girder datasets. Currently used for continuous integration (CI) tests on the VIP platform.

vip_client.classes.VipLoader

[Work in progress] A class that implements everything needed to upload/download data to/from VIP servers. More information to come.

vip_client.classes.VipClient

[Work in progress] Base class to communicate with VIP. More information to come.

Modules

vip_client.utils.vip

This package implements synchronous requests to the VIP (RESTful) API (through the requests Python library).

  • How to use it: This module works like a state machine: first, set the apikey with setApiKey(str). All the functions will refer to this apikey later.
  • Raised errors: If there are any VIP issues, functions will raise RuntimeError errors. See detect_errors and manage_errors functions if you want to change this.
  • Future Work: An asynchronous version