Skip to main content

OurSky Astro

Project description

ourskyai-astro-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.3671
  • Package version: 1.3.3671
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

pip install ourskyai_astro_api

(you may need to run pip with root permission: sudo pip install ourskyai_astro_api)

Poetry install

If you manage dependencies with poetry then you can add the SDK with:

poetry add ourskyai_astro_api

Import the package

Then import the package:

import ourskyai_astro_api

Getting Started

Please follow the installation procedure and then run the following:

import os
import ourskyai_astro_api
from ourskyai_astro_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_astro_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_astro_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with ourskyai_astro_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ourskyai_astro_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_create_astro_camera POST /v1/astro-camera
DefaultApi v1_create_astro_mount POST /v1/astro-mount
DefaultApi v1_create_astro_optical_tube POST /v1/astro-optical-tube
DefaultApi v1_create_astro_project POST /v1/astro-project
DefaultApi v1_create_astro_project_image_set POST /v1/astro-project-image-set
DefaultApi v1_create_calibration_master POST /v1/calibration-master
DefaultApi v1_create_image_set POST /v1/image-set
DefaultApi v1_create_image_set_image POST /v1/image-set-image
DefaultApi v1_create_node POST /v1/node
DefaultApi v1_delete_astro_project DELETE /v1/astro-project
DefaultApi v1_delete_calibration_master DELETE /v1/calibration-master
DefaultApi v1_delete_image_set DELETE /v1/image-set
DefaultApi v1_delete_image_set_image DELETE /v1/image-set-image
DefaultApi v1_get_astro_camera GET /v1/astro-camera
DefaultApi v1_get_astro_mount GET /v1/astro-mount
DefaultApi v1_get_astro_optical_tube GET /v1/astro-optical-tube
DefaultApi v1_get_astro_platform_credit_balance GET /v1/astro-platform-credit-balance
DefaultApi v1_get_astro_project GET /v1/astro-project
DefaultApi v1_get_astro_project_assets GET /v1/astro-project-assets
DefaultApi v1_get_astro_projects GET /v1/astro-projects
DefaultApi v1_get_astro_target GET /v1/astro-target
DefaultApi v1_get_astro_targets GET /v1/astro-targets
DefaultApi v1_get_calibration_masters GET /v1/calibration-masters
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_image_set_images GET /v1/image-set-images
DefaultApi v1_get_image_sets GET /v1/image-sets
DefaultApi v1_get_job_logs GET /v1/job-logs
DefaultApi v1_get_nodes GET /v1/nodes
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_get_platform_credits GET /v1/platform-credits
DefaultApi v1_get_weather GET /v1/weather
DefaultApi v1_match_astro_project GET /v1/astro-project-match
DefaultApi v1_mount_match GET /v1/mount-match
DefaultApi v1_optical_tube_match GET /v1/optical-tube-match
DefaultApi v1_put_stack_astro_project PUT /v1/stack-astro-project
DefaultApi v1_update_node PUT /v1/node

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerToken

  • Type: Bearer authentication

Roles

Author

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ourskyai_astro_api-1.3.3671.tar.gz (46.7 kB view hashes)

Uploaded Source

Built Distribution

ourskyai_astro_api-1.3.3671-py3-none-any.whl (102.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page