osparc-client 0.6.0

osparc.io web API (dev)

Python client for osparc-simcore public web API

• API version: 0.4.5-dev
• Package version: 0.6.0

Requirements.

Python 3.6+

Installation & Usage

pip install

To install run

pip install osparc_client

(you may need to run pip with root permission)

Then import the package:

import osparc_client

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 osparc_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import osparc_client
from osparc_client.rest import ApiException
from pprint import pprint

configuration = osparc_client.Configuration()
# Configure HTTP basic authorization: HTTPBasic
configuration.username = 'YOUR_API_KEY_HERE'
configuration.password = 'YOUR_API_SECRET_HERE'

# Enter a context with an instance of the API client
with osparc_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = osparc_client.FilesApi(api_client)
    file_id = 'file_id_example' # str | 
body_abort_multipart_upload_v0_files_file_id_abort_post = osparc_client.BodyAbortMultipartUploadV0FilesFileIdAbortPost() # BodyAbortMultipartUploadV0FilesFileIdAbortPost | 

    try:
        # Abort Multipart Upload
        api_response = api_instance.abort_multipart_upload(file_id, body_abort_multipart_upload_v0_files_file_id_abort_post)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FilesApi->abort_multipart_upload: %s\n" % e)
    

Documentation for API Classes

All URIs are relative to https://api.osparc.io

Class	Method	HTTP request	Description
FilesApi	abort_multipart_upload	POST /v0/files/{file_id}:abort	Abort Multipart Upload
FilesApi	complete_multipart_upload	POST /v0/files/{file_id}:complete	Complete Multipart Upload
FilesApi	delete_file	DELETE /v0/files/{file_id}	Delete File
FilesApi	download_file	GET /v0/files/{file_id}/content	Download File
FilesApi	get_file	GET /v0/files/{file_id}	Get File
FilesApi	get_files_page	GET /v0/files/page	Get Files Page
FilesApi	get_upload_links	POST /v0/files/content	Get Upload Links
FilesApi	list_files	GET /v0/files	List Files
FilesApi	search_files_page	GET /v0/files:search	Search Files Page
FilesApi	upload_file	PUT /v0/files/content	Upload File
MetaApi	get_service_metadata	GET /v0/meta	Get Service Metadata
SolversApi	create_job	POST /v0/solvers/{solver_key}/releases/{version}/jobs	Create Job
SolversApi	delete_job	DELETE /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}	Delete Job
SolversApi	get_job	GET /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}	Get Job
SolversApi	get_job_custom_metadata	GET /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata	Get Job Custom Metadata
SolversApi	get_job_output_logfile	GET /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs/logfile	Get Job Output Logfile
SolversApi	get_job_outputs	GET /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs	Get Job Outputs
SolversApi	get_jobs_page	GET /v0/solvers/{solver_key}/releases/{version}/jobs/page	Get Jobs Page
SolversApi	get_solver	GET /v0/solvers/{solver_key}/latest	Get Latest Release of a Solver
SolversApi	get_solver_release	GET /v0/solvers/{solver_key}/releases/{version}	Get Solver Release
SolversApi	get_solver_releases_page	GET /v0/solvers/{solver_key}/releases/page	Get Solver Releases Page
SolversApi	get_solvers_page	GET /v0/solvers/page	Get Solvers Page
SolversApi	get_solvers_releases_page	GET /v0/solvers/releases/page	Get Solvers Releases Page
SolversApi	inspect_job	POST /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:inspect	Inspect Job
SolversApi	list_jobs	GET /v0/solvers/{solver_key}/releases/{version}/jobs	List Jobs
SolversApi	list_solver_ports	GET /v0/solvers/{solver_key}/releases/{version}/ports	List Solver Ports
SolversApi	list_solver_releases	GET /v0/solvers/{solver_key}/releases	List Solver Releases
SolversApi	list_solvers	GET /v0/solvers	List Solvers
SolversApi	list_solvers_releases	GET /v0/solvers/releases	Lists All Releases
SolversApi	replace_job_custom_metadata	PATCH /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata	Replace Job Custom Metadata
SolversApi	start_job	POST /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:start	Start Job
SolversApi	stop_job	POST /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:stop	Stop Job
StudiesApi	clone_study	POST /v0/studies/{study_id}:clone	Clone Study
StudiesApi	create_study_job	POST /v0/studies/{study_id}/jobs	Create Study Job
StudiesApi	delete_study_job	DELETE /v0/studies/{study_id}/jobs/{job_id}	Delete Study Job
StudiesApi	get_study	GET /v0/studies/{study_id}	Get Study
StudiesApi	get_study_job	GET /v0/studies/{study_id}/jobs/{job_id}	Get Study Job
StudiesApi	get_study_job_custom_metadata	GET /v0/studies/{study_id}/jobs/{job_id}/metadata	Get Study Job Custom Metadata
StudiesApi	get_study_job_output_logfile	POST /v0/studies/{study_id}/jobs/{job_id}/outputs/logfile	Get Study Job Output Logfile
StudiesApi	get_study_job_outputs	POST /v0/studies/{study_id}/jobs/{job_id}/outputs	Get Study Job Outputs
StudiesApi	inspect_study_job	POST /v0/studies/{study_id}/jobs/{job_id}:inspect	Inspect Study Job
StudiesApi	list_studies	GET /v0/studies	List Studies
StudiesApi	list_study_jobs	GET /v0/studies/{study_id}/jobs	List Study Jobs
StudiesApi	list_study_ports	GET /v0/studies/{study_id}/ports	List Study Ports
StudiesApi	replace_study_job_custom_metadata	PUT /v0/studies/{study_id}/jobs/{job_id}/metadata	Replace Study Job Custom Metadata
StudiesApi	start_study_job	POST /v0/studies/{study_id}/jobs/{job_id}:start	Start Study Job
StudiesApi	stop_study_job	POST /v0/studies/{study_id}/jobs/{job_id}:stop	Stop Study Job
UsersApi	get_my_profile	GET /v0/me	Get My Profile
UsersApi	update_my_profile	PUT /v0/me	Update My Profile

Documentation For Models

• BodyAbortMultipartUploadV0FilesFileIdAbortPost
• BodyCompleteMultipartUploadV0FilesFileIdCompletePost
• BodyUploadFileV0FilesContentPut
• ClientFile
• ClientFileUploadData
• ErrorGet
• File
• FileUploadCompletionBody
• FileUploadData
• Groups
• HTTPValidationError
• Job
• JobInputs
• JobMetadata
• JobMetadataUpdate
• JobOutputs
• JobStatus
• Links
• Meta
• OnePageSolverPort
• OnePageStudyPort
• PageFile
• PageJob
• PageSolver
• PageStudy
• Profile
• ProfileUpdate
• RunningState
• Solver
• SolverPort
• Study
• StudyPort
• UploadLinks
• UploadedPart
• UserRoleEnum
• UsersGroup
• ValidationError

Documentation For Authorization

HTTPBasic

• Type: HTTP basic authentication

Author