Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 3.23 KB

README.md

File metadata and controls

112 lines (73 loc) · 3.23 KB
Raw

esmfold-microservice

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: 0.1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

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 esmfold_microservice

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 esmfold_microservice

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import esmfold_microservice
from esmfold_microservice.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = esmfold_microservice.Configuration(
    host = "http://localhost"
)



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

    try:
        # Get Running Jobs
        api_response = api_instance.get_running_jobs_jobs_running_get()
        print("The response of DefaultApi->get_running_jobs_jobs_running_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_running_jobs_jobs_running_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
DefaultApi get_running_jobs_jobs_running_get GET /jobs/running Get Running Jobs
DefaultApi is_job_running_job_job_id_is_running_get GET /job/{job_id}/is-running Is Job Running
DefaultApi predict_run_folding_post POST /run-folding Predict

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author