ourskyai_node_platform_api 1.3.11012__tar.gz → 1.3.11360__tar.gz

ourskyai_node_platform_api-1.3.11360/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: ourskyai_node_platform_api
+Version: 1.3.11360
+Summary: OurSky
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: OpenAPI Generator Community <team@openapitools.org>
+Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
+Keywords: OpenAPI,OpenAPI-Generator,OurSky
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+
+# ourskyai-node-platform-api
+Node Platform API
+The Node Platform API enables a customer to directly command their ground station either directly via IP address, via the self hosted C2 platform, or routed transparently via the Observable Space cloud platform.
+Node Platform APIs offer every endpoint a customer might need in order to slew their scope, perform diagnostics, capture images, and much more. 
+Are we missing a feature you need? Drop us a line at support@observable.space.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.3.11360
+- Package version: 1.3.11360
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install ourskyai_node_platform_api
+```
+(you may need to run `pip` with root permission: `sudo pip install ourskyai_node_platform_api`)
+
+### Poetry install
+If you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:
+
+```sh
+poetry add ourskyai_node_platform_api
+```
+
+### Import the package
+
+Then import the package:
+```python
+import ourskyai_node_platform_api
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import os
+import ourskyai_node_platform_api
+from ourskyai_node_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_node_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_node_platform_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with ourskyai_node_platform_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = ourskyai_node_platform_api.DefaultApi(api_client)
+    v1_cancel_all_tasks_request = ourskyai_node_platform_api.V1CancelAllTasksRequest() # V1CancelAllTasksRequest | 
+    lineage_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Lineage ID required when requesting data from the cloud platform (optional)
+
+    try:
+        api_response = api_instance.v1_cancel_all_tasks(v1_cancel_all_tasks_request, lineage_id=lineage_id)
+        print("The response of DefaultApi->v1_cancel_all_tasks:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling DefaultApi->v1_cancel_all_tasks: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.prod.oursky.ai/docs/node_platform*
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="BearerToken"></a>
+### BearerToken
+
+- **Type**: Bearer authentication
+
+<a id="Roles"></a>
+### Roles
+
+
+
+## Author
+
+

ourskyai_node_platform_api-1.3.11360/README.md

@@ -0,0 +1,104 @@
+# ourskyai-node-platform-api
+Node Platform API
+The Node Platform API enables a customer to directly command their ground station either directly via IP address, via the self hosted C2 platform, or routed transparently via the Observable Space cloud platform.
+Node Platform APIs offer every endpoint a customer might need in order to slew their scope, perform diagnostics, capture images, and much more. 
+Are we missing a feature you need? Drop us a line at support@observable.space.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.3.11360
+- Package version: 1.3.11360
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+```sh
+pip install ourskyai_node_platform_api
+```
+(you may need to run `pip` with root permission: `sudo pip install ourskyai_node_platform_api`)
+
+### Poetry install
+If you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:
+
+```sh
+poetry add ourskyai_node_platform_api
+```
+
+### Import the package
+
+Then import the package:
+```python
+import ourskyai_node_platform_api
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import os
+import ourskyai_node_platform_api
+from ourskyai_node_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_node_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_node_platform_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with ourskyai_node_platform_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = ourskyai_node_platform_api.DefaultApi(api_client)
+    v1_cancel_all_tasks_request = ourskyai_node_platform_api.V1CancelAllTasksRequest() # V1CancelAllTasksRequest | 
+    lineage_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Lineage ID required when requesting data from the cloud platform (optional)
+
+    try:
+        api_response = api_instance.v1_cancel_all_tasks(v1_cancel_all_tasks_request, lineage_id=lineage_id)
+        print("The response of DefaultApi->v1_cancel_all_tasks:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling DefaultApi->v1_cancel_all_tasks: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.prod.oursky.ai/docs/node_platform*
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="BearerToken"></a>
+### BearerToken
+
+- **Type**: Bearer authentication
+
+<a id="Roles"></a>
+### Roles
+
+
+
+## Author
+
+