oort-sdk-client

Client interface to the OORT agent.

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

• API version: 1.5
• Package version: 1.5.15
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://developers.spire.com/oort-docs/index.html

Requirements.

Python 3.10+ (see requires-python in pyproject.toml)

Installation & Usage

poetry

Install locally from the SDK directory using:

poetry install

This will install both the package and all of its dependencies in a virtualenv.

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 oort_sdk_client

Setuptools

Install via Setuptools.

python3 setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import oort_sdk_client

Tests

Execute pytest to run the tests.

If you installed the package and its dependencies using poetry, run:

poetry run pytest test

Getting Started

Please follow the installation procedure and then run the following:

import oort_sdk_client
from oort_sdk_client.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with oort_sdk_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = oort_sdk_client.SdkApi(api_client)
    adcs_command_request = oort_sdk_client.AdcsCommandRequest() # AdcsCommandRequest | The file and parameters for sending

    try:
        api_response = api_instance.command_adcs(adcs_command_request)
        print("The response of SdkApi->command_adcs:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SdkApi->command_adcs: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:2005/sdk/v1

Class	Method	HTTP request	Description
SdkApi	command_adcs	POST /adcs
SdkApi	get_adcs	GET /adcs
SdkApi	get_tfrs	GET /tfrs
SdkApi	query_available_files	GET /query_available_files/{topic}
SdkApi	retrieve_file	POST /retrieve_file
SdkApi	send_file	POST /send_file

Documentation For Models

• AdcsCommandRequest
• AdcsCommandResponse
• AdcsEulerT
• AdcsHk
• AdcsQuatT
• AdcsResponse
• AdcsTarget
• AdcsXyzFloatT
• AvailableFilesResponse
• DeliveryHints
• ErrorResponse
• FileInfo
• RetrieveFileRequest
• SendFileRequest
• SendFileResponse
• SendOptions
• TTLParams
• TfrsResponse

Documentation For Authorization

Endpoints do not require authorization.

Author