OurSky SDA
Project description
ourskyai-sda-api
The basic flow for a new organization is as follows:
- View the available satellite targets with the satellite targets endpoint. Copy the id of the target you want to observe.
- Create an organization target with the organization target endpoint. Use the id copied from above.
- Create a webhook with the webhook endpoint to receive TDMs automatically (preferred) or use the tdms endpoint to poll for TDMs.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.3.1905
- Package version: 1.3.1905
- 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_sda_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_sda_api
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import time
import ourskyai_sda_api
from ourskyai_sda_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_sda_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_sda_api.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with ourskyai_sda_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ourskyai_sda_api.DefaultApi(api_client)
v1_create_image_set_request = ourskyai_sda_api.V1CreateImageSetRequest() # V1CreateImageSetRequest |
try:
api_response = api_instance.v1_create_image_set(v1_create_image_set_request)
print("The response of DefaultApi->v1_create_image_set:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->v1_create_image_set: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.prod.oursky.ai
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | v1_create_image_set | POST /v1/image-set | |
DefaultApi | v1_create_image_set_image | POST /v1/image-set-image | |
DefaultApi | v1_create_organization_target | POST /v1/organization-target | |
DefaultApi | v1_create_webhook_configuration | POST /v1/communications/webhook | |
DefaultApi | v1_delete_organization_target | DELETE /v1/organization-target | |
DefaultApi | v1_delete_webhook_configuration | DELETE /v1/communications/webhook | |
DefaultApi | v1_get_image_set | GET /v1/image-set | |
DefaultApi | v1_get_image_set_image | GET /v1/image-set-image | |
DefaultApi | v1_get_image_set_images | GET /v1/image-set-images | |
DefaultApi | v1_get_image_sets | GET /v1/image-sets | |
DefaultApi | v1_get_observation_sequence_results | GET /v1/observation-sequence-results | |
DefaultApi | v1_get_organization_targets | GET /v1/organization-targets | |
DefaultApi | v1_get_satellite_potentials | GET /v1/satellite-target-potentials | |
DefaultApi | v1_get_satellite_targets | GET /v1/satellite-targets | |
DefaultApi | v1_get_tdm | GET /v1/tdm | |
DefaultApi | v1_get_tdms | GET /v1/tdms | |
DefaultApi | v1_get_webhook_configurations | GET /v1/communications/webhooks | |
DefaultApi | v1_update_email_configuration | PUT /v1/communications/email |
Documentation For Models
- AstrometricOffsets
- EmptySuccess
- FilterType
- ObservationResult
- OrbitType
- SuccessfulCreate
- TrackingType
- V1CreateImageSetImageRequest
- V1CreateImageSetImageResponse
- V1CreateImageSetRequest
- V1CreateOrganizationTargetRequest
- V1GetSatelliteTargetsResponse
- V1ImageSet
- V1ImageSetImage
- V1ObservationSequenceResult
- V1ObservationSequenceResultImageSetsInner
- V1OrganizationTarget
- V1SatellitePotential
- V1SatelliteTarget
- V1Tdm
- V1UpdateEmailConfigurationRequest
- V1UpdateWebhookConfigurationRequest
- V1WebhookConfiguration
- WebhookEvent
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_sda_api-1.3.1905.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 644ce824311fe986f2d65d87b26e7b7850368b28d683fc2fee5a1285e6130ed1 |
|
MD5 | 1ddc0878d464f4a9e8e04ba007f610df |
|
BLAKE2b-256 | 8817ef1848c60d10e28c617d3b67385ffeaff3e027156a46ced9513e8c3bc214 |
Hashes for ourskyai_sda_api-1.3.1905-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 864c7927e5aef9fea85f78ee896a03dd5a3851b0c574dda16d80bdd1827b2a9c |
|
MD5 | cc38c9ed73efb29b74ec3bbbdb71e594 |
|
BLAKE2b-256 | 7201d7ab6caf3e1e506d78d8fcf329ebdd9f65aafc67a6b210eb2ce43f98e5c2 |