/opus_openapi

OpenAPI generated API to the PDS Ring-Moon Systems node

Primary LanguagePythonMIT LicenseMIT

swagger-client

This is a simple API wrapping the OPUS API of the PDS Ring-Moon Systems node.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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 swagger_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 swagger_client

Getting Started

Please follow the installation procedure and then run the following:

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

# create an instance of the API class
api_instance = swagger_client.DefaultApi(swagger_client.ApiClient(configuration))
opus_id = 'opus_id_example' # str | valid opus_id (or old ring_obs_id)
cols = ['cols_example'] # list[str] | one or more column names (optional)

try:
    api_response = api_instance.metadata_v2_opus_id_json_get(opus_id, cols=cols)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->metadata_v2_opus_id_json_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://tools.pds-rings.seti.org/opus/api

Class Method HTTP request Description
DefaultApi metadata_v2_opus_id_json_get GET /metadata_v2/{opus_id}.json

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

kmichael.aye@gmail.com