rocc-client 0.1.3

ROCC Client Library for Python

ROCC Client Library for Python

Introduction

TBA

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.3
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://Sage-Bionetworks.github.io/rocc-schemas

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import roccclient

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 roccclient

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import roccclient
from roccclient.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://rocc.org/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = roccclient.Configuration(
    host = "https://rocc.org/api/v1"
)



# Enter a context with an instance of the API client
with roccclient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = roccclient.ChallengeApi(api_client)
    challenge = roccclient.Challenge() # Challenge |

    try:
        # Add a challenge
        api_response = api_instance.create_challenge(challenge)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ChallengeApi->create_challenge: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://rocc.org/api/v1

Class	Method	HTTP request	Description
ChallengeApi	create_challenge	POST /challenges	Add a challenge
ChallengeApi	delete_challenge	DELETE /challenges/{challengeId}	Delete a challenge
ChallengeApi	get_challenge	GET /challenges/{challengeId}	Get a challenge
ChallengeApi	list_challenges	GET /challenges	List all the challenges
GrantApi	create_grant	POST /grants	Create a grant
GrantApi	delete_grant	DELETE /grants/{grantId}	Delete a grant
GrantApi	get_grant	GET /grants/{grantId}	Get a grant
GrantApi	list_grants	GET /grants	Get all grants
OrganizationApi	create_organization	POST /organizations	Create an organization
OrganizationApi	delete_organization	DELETE /organizations/{organizationId}	Delete an organization
OrganizationApi	get_organization	GET /organizations/{organizationId}	Get an organization
OrganizationApi	list_organizations	GET /organizations	Get all organizations
PersonApi	create_person	POST /persons	Create a person
PersonApi	delete_person	DELETE /persons/{personId}	Delete a person
PersonApi	get_person	GET /persons/{personId}	Get a person
PersonApi	list_persons	GET /persons	Get all persons
TagApi	create_tag	POST /tags	Create a tag
TagApi	delete_tag	DELETE /tags/{tagId}	Delete a tag
TagApi	get_tag	GET /tags/{tagId}	Get a tag
TagApi	list_tags	GET /tags	Get all tags

Documentation For Models

• Challenge
• ChallengeFilter
• ChallengeResults
• ChallengeStatus
• Error
• Grant
• Organization
• PageOfChallenges
• PageOfChallengesAllOf
• PageOfGrants
• PageOfGrantsAllOf
• PageOfOrganizations
• PageOfOrganizationsAllOf
• PageOfPersons
• PageOfPersonsAllOf
• PageOfTags
• PageOfTagsAllOf
• Person
• PersonFilter
• ResponsePageMetadata
• ResponsePageMetadataLinks
• Tag
• TagFilter

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]