Skip to content

Latest commit

 

History

History
166 lines (113 loc) · 6.85 KB

README.md

File metadata and controls

166 lines (113 loc) · 6.85 KB
Raw

VCell API client

pypi python Build Status codecov

Client library to connect to VCell remote API

Features

  • TODO

Credits

This package was created with Cookiecutter and the waynerv/cookiecutter-pypackage project template.

Background

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

  • API version: 1.0.1
  • Package version: 0.1.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit http://exampleurl.com/contact

Requirements.

Python 3.9+

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 vcell_api_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 vcell_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import vcell_api_client
from vcell_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://vcellapi-test.cam.uchc.edu
# See configuration.py for a list of all supported configuration parameters.
configuration = vcell_api_client.Configuration(
    host = "https://vcellapi-test.cam.uchc.edu"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.


# Enter a context with an instance of the API client
with vcell_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vcell_api_client.AdminResourceApi(api_client)

    try:
        # Get usage summary
        api_response = api_instance.get_usage()
        print("The response of AdminResourceApi->get_usage:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminResourceApi->get_usage: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://vcellapi-test.cam.uchc.edu

Class Method HTTP request Description
AdminResourceApi get_usage GET /api/v1/admin/usage Get usage summary
BioModelResourceApi delete_bio_model DELETE /api/v1/bioModel/{bioModelID} Delete the BioModel from VCell's database.
BioModelResourceApi get_biomodel_by_id GET /api/v1/bioModel/{bioModelID} Get BioModel information in JSON format by ID.
BioModelResourceApi upload_bio_model POST /api/v1/bioModel/upload_bioModel Upload the BioModel to VCell database. Returns BioModel ID.
HelloWorldApi get_hello_world GET /api/v1/helloworld Get hello world message.
PublicationResourceApi create_publication POST /api/v1/publications Create publication
PublicationResourceApi delete_publication DELETE /api/v1/publications/{id} Delete publication
PublicationResourceApi get_publication_by_id GET /api/v1/publications/{id} Get publication by ID
PublicationResourceApi get_publications GET /api/v1/publications Get all publications
PublicationResourceApi update_publication PUT /api/v1/publications Create publication
UsersResourceApi forgot_legacy_password POST /api/v1/users/forgotLegacyPassword The end user has forgotten the legacy password they used for VCell, so they will be emailed it.
UsersResourceApi get_legacy_api_token POST /api/v1/users/bearerToken Get token for legacy API
UsersResourceApi get_mapped_user GET /api/v1/users/mappedUser Get mapped VCell identity
UsersResourceApi get_me GET /api/v1/users/me Get current user
UsersResourceApi map_new_user POST /api/v1/users/newUser create vcell user
UsersResourceApi map_user POST /api/v1/users/mapUser map vcell user
UsersResourceApi unmap_user PUT /api/v1/users/unmapUser/{userName} remove vcell identity mapping

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

openId

Author

vcell_support@uchc.com