OurSky Platform
Project description
ourskyai-platform-api
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: 1.3.1945
- Package version: 1.3.1945
- 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 ourskyai_platform_api
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 ourskyai_platform_api
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import ourskyai_platform_api
from ourskyai_platform_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.prod.oursky.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = ourskyai_platform_api.Configuration(
host = "https://api.prod.oursky.ai"
)
# 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.
# Configure Bearer authorization: BearerToken
configuration = ourskyai_platform_api.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with ourskyai_platform_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ourskyai_platform_api.DefaultApi(api_client)
model = 'model_example' # str | (optional)
pixel_size_microns = 3.4 # float | (optional)
pixels_x = 56 # int | (optional)
pixels_y = 56 # int | (optional)
megapixels = 3.4 # float | (optional)
chilled = True # bool | (optional)
adc_bit_depth = 56 # int | (optional)
is_color = True # bool | (optional)
try:
api_response = api_instance.v1_camera_match(model=model, pixel_size_microns=pixel_size_microns, pixels_x=pixels_x, pixels_y=pixels_y, megapixels=megapixels, chilled=chilled, adc_bit_depth=adc_bit_depth, is_color=is_color)
print("The response of DefaultApi->v1_camera_match:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->v1_camera_match: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.prod.oursky.ai
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | v1_camera_match | GET /v1/camera-match | |
DefaultApi | v1_complete_observation | PUT /v1/observation-complete | |
DefaultApi | v1_create_image_set | POST /v1/image-set | |
DefaultApi | v1_create_image_set_image | POST /v1/image-set-image | |
DefaultApi | v1_create_metrics | POST /v1/metrics | |
DefaultApi | v1_create_mount | POST /v1/mount | |
DefaultApi | v1_create_node_diagnostics | POST /v1/node-diagnostics | |
DefaultApi | v1_create_optical_tube | POST /v1/optical-tube | |
DefaultApi | v1_get_cameras | GET /v1/cameras | |
DefaultApi | v1_get_image_set | GET /v1/image-set | |
DefaultApi | v1_get_image_set_image | GET /v1/image-set-image | |
DefaultApi | v1_get_mount | GET /v1/mount | |
DefaultApi | v1_get_node_diagnostic_tasks | GET /v1/node-diagnostic-tasks | |
DefaultApi | v1_get_node_properties | GET /v1/node-properties | |
DefaultApi | v1_get_nodes | GET /v1/nodes | |
DefaultApi | v1_get_optical_tube | GET /v1/optical-tube | |
DefaultApi | v1_get_or_create_camera | PUT /v1/camera-match | |
DefaultApi | v1_get_or_create_mount | PUT /v1/mount-match | |
DefaultApi | v1_get_or_create_optical_tube | PUT /v1/optical-tube-match | |
DefaultApi | v1_mount_match | GET /v1/mount-match | |
DefaultApi | v1_optical_tube_match | GET /v1/optical-tube-match | |
DefaultApi | v1_update_node_components | PUT /v1/node-components | |
DefaultApi | v1_update_node_metrics | PUT /v1/node-metrics | |
DefaultApi | v2_get_observation | GET /v2/observation |
Documentation For Models
- CameraMode
- EmptySuccess
- FilterType
- Location
- MetricType
- MountType
- NodeState
- OpticalTubeType
- ShutterType
- SuccessfulCreate
- TrackingType
- V1Camera
- V1CompleteObservationRequest
- V1CreateImageSetImageRequest
- V1CreateImageSetImageResponse
- V1CreateImageSetRequest
- V1CreateMountRequest
- V1CreateNodeDiagnosticRequest
- V1CreateOpticalTubeRequest
- V1GainCurve
- V1GainCurvePoint
- V1GetNodes
- V1GetOrCreateCameraRequest
- V1GetOrCreateMountRequest
- V1GetOrCreateOpticalTubeRequest
- V1GroundStationParticipant
- V1ImageSet
- V1ImageSetImage
- V1Metric
- V1Mount
- V1Node
- V1NodeComponentType
- V1NodeDiagnosticType
- V1NodeWithLocation
- V1OpticalTube
- V1ReadNoisePoint
- V1SetupAction
- V1UpdateNodeComponentsRequest
- V1UpdateNodeComponentsRequestCamera
- V1UpdateNodeComponentsRequestMount
- V1UpdateNodeComponentsRequestOpticalTube
- V1UpdateNodeMetricsRequest
- V2GetObservationResponse
Documentation For Authorization
Authentication schemes defined for the API:
BearerToken
- Type: Bearer authentication
Roles
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ourskyai_platform_api-1.3.1945.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fea673d14e0e587b79561133aead53d03af759e8c50156855825ec1344163bc |
|
MD5 | f7a75ddff778c18fc89b025021b4bf33 |
|
BLAKE2b-256 | 8a1bc7a675eb8587688a04647b262364a510485b0f09d34d3a559b23d1706317 |
Hashes for ourskyai_platform_api-1.3.1945-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61e7c8b136d2e4f18385f992850bd5e585783a86a2abb08bafa8ef2f41c85637 |
|
MD5 | 20c44343057bff990936494ee4e6f468 |
|
BLAKE2b-256 | f02aaee52e01676a066ab3cde5f97b11ba4b4bc6b9993e53fb28b4511423cf14 |