ourskyai_node_platform_api 1.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ourskyai_node_platform_api-1.3.0/PKG-INFO +23 -0
- ourskyai_node_platform_api-1.3.0/README.md +100 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/__init__.py +51 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/api/__init__.py +5 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/api/default_api.py +937 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/api_client.py +758 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/api_response.py +25 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/configuration.py +442 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/exceptions.py +166 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/__init__.py +34 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/camera_status.py +85 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/empty_success.py +71 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/focuser_position.py +81 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/focuser_status.py +79 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/mount_status.py +91 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/optical_tube_status.py +71 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/relays_status.py +71 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/roof_status.py +71 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_filter_wheel_status.py +75 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_get_component_status_response.py +127 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_get_storage_status_response.py +75 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_interface_info.py +75 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_mount_go_to_coordinates_request.py +77 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_network_interface.py +83 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_post_alpaca_connection_event_request.py +71 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_safety_status.py +81 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/v1_update_network_interface_request.py +81 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/models/weather_station_status.py +71 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/py.typed +0 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api/rest.py +303 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api.egg-info/PKG-INFO +23 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api.egg-info/SOURCES.txt +56 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api.egg-info/dependency_links.txt +1 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api.egg-info/requires.txt +4 -0
- ourskyai_node_platform_api-1.3.0/ourskyai_node_platform_api.egg-info/top_level.txt +1 -0
- ourskyai_node_platform_api-1.3.0/pyproject.toml +30 -0
- ourskyai_node_platform_api-1.3.0/setup.cfg +7 -0
- ourskyai_node_platform_api-1.3.0/setup.py +49 -0
- ourskyai_node_platform_api-1.3.0/test/test_camera_status.py +67 -0
- ourskyai_node_platform_api-1.3.0/test/test_default_api.py +67 -0
- ourskyai_node_platform_api-1.3.0/test/test_empty_success.py +52 -0
- ourskyai_node_platform_api-1.3.0/test/test_focuser_position.py +58 -0
- ourskyai_node_platform_api-1.3.0/test/test_focuser_status.py +62 -0
- ourskyai_node_platform_api-1.3.0/test/test_mount_status.py +73 -0
- ourskyai_node_platform_api-1.3.0/test/test_optical_tube_status.py +53 -0
- ourskyai_node_platform_api-1.3.0/test/test_relays_status.py +53 -0
- ourskyai_node_platform_api-1.3.0/test/test_roof_status.py +53 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_filter_wheel_status.py +57 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_get_component_status_response.py +155 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_get_storage_status_response.py +57 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_interface_info.py +57 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_mount_go_to_coordinates_request.py +55 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_network_interface.py +66 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_post_alpaca_connection_event_request.py +53 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_safety_status.py +62 -0
- ourskyai_node_platform_api-1.3.0/test/test_v1_update_network_interface_request.py +65 -0
- ourskyai_node_platform_api-1.3.0/test/test_weather_station_status.py +53 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ourskyai-node-platform-api
|
|
3
|
+
Version: 1.3.0
|
|
4
|
+
Summary: OurSky
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: team@openapitools.org
|
|
8
|
+
Keywords: OpenAPI,OpenAPI-Generator,OurSky
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
Requires-Dist: urllib3<2.1.0,>=1.25.3
|
|
11
|
+
Requires-Dist: python-dateutil
|
|
12
|
+
Requires-Dist: pydantic<2,>=1.10.5
|
|
13
|
+
Requires-Dist: aenum
|
|
14
|
+
Dynamic: author
|
|
15
|
+
Dynamic: author-email
|
|
16
|
+
Dynamic: description
|
|
17
|
+
Dynamic: description-content-type
|
|
18
|
+
Dynamic: keywords
|
|
19
|
+
Dynamic: requires-dist
|
|
20
|
+
Dynamic: summary
|
|
21
|
+
|
|
22
|
+
Fully merged Converged Node Platform API documentation
|
|
23
|
+
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# ourskyai-node-platform-api
|
|
2
|
+
Fully merged Converged Node Platform API documentation
|
|
3
|
+
|
|
4
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
5
|
+
|
|
6
|
+
- API version: 1.3.0
|
|
7
|
+
- Package version: 1.3.0
|
|
8
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
9
|
+
|
|
10
|
+
## Requirements.
|
|
11
|
+
|
|
12
|
+
Python 3.7+
|
|
13
|
+
|
|
14
|
+
## Installation & Usage
|
|
15
|
+
### pip install
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
pip install ourskyai_node_platform_api
|
|
19
|
+
```
|
|
20
|
+
(you may need to run `pip` with root permission: `sudo pip install ourskyai_node_platform_api`)
|
|
21
|
+
|
|
22
|
+
### Poetry install
|
|
23
|
+
If you manage dependencies with [poetry](https://python-poetry.org/) then you can add the SDK with:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
poetry add ourskyai_node_platform_api
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Import the package
|
|
30
|
+
|
|
31
|
+
Then import the package:
|
|
32
|
+
```python
|
|
33
|
+
import ourskyai_node_platform_api
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Getting Started
|
|
37
|
+
|
|
38
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
39
|
+
|
|
40
|
+
```python
|
|
41
|
+
|
|
42
|
+
import os
|
|
43
|
+
import ourskyai_node_platform_api
|
|
44
|
+
from ourskyai_node_platform_api.rest import ApiException
|
|
45
|
+
from pprint import pprint
|
|
46
|
+
|
|
47
|
+
# Defining the host is optional and defaults to http://localhost:8080
|
|
48
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
49
|
+
configuration = ourskyai_node_platform_api.Configuration(
|
|
50
|
+
host = "http://localhost:8080"
|
|
51
|
+
)
|
|
52
|
+
|
|
53
|
+
# The client must configure the authentication and authorization parameters
|
|
54
|
+
# in accordance with the API server security policy.
|
|
55
|
+
# Examples for each auth method are provided below, use the example that
|
|
56
|
+
# satisfies your auth use case.
|
|
57
|
+
|
|
58
|
+
# Configure Bearer authorization: BearerToken
|
|
59
|
+
configuration = ourskyai_node_platform_api.Configuration(
|
|
60
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
61
|
+
)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
# Enter a context with an instance of the API client
|
|
65
|
+
with ourskyai_node_platform_api.ApiClient(configuration) as api_client:
|
|
66
|
+
# Create an instance of the API class
|
|
67
|
+
api_instance = ourskyai_node_platform_api.DefaultApi(api_client)
|
|
68
|
+
lineage_id = 'lineage_id_example' # str | Optional lineage ID for tracking purposes (optional)
|
|
69
|
+
|
|
70
|
+
try:
|
|
71
|
+
api_response = api_instance.v1_get_component_status(lineage_id=lineage_id)
|
|
72
|
+
print("The response of DefaultApi->v1_get_component_status:\n")
|
|
73
|
+
pprint(api_response)
|
|
74
|
+
except ApiException as e:
|
|
75
|
+
print("Exception when calling DefaultApi->v1_get_component_status: %s\n" % e)
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Documentation for API Endpoints
|
|
80
|
+
|
|
81
|
+
All URIs are relative to *http://localhost:8080/docs/node_platform*
|
|
82
|
+
|
|
83
|
+
<a id="documentation-for-authorization"></a>
|
|
84
|
+
## Documentation For Authorization
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
Authentication schemes defined for the API:
|
|
88
|
+
<a id="BearerToken"></a>
|
|
89
|
+
### BearerToken
|
|
90
|
+
|
|
91
|
+
- **Type**: Bearer authentication
|
|
92
|
+
|
|
93
|
+
<a id="Roles"></a>
|
|
94
|
+
### Roles
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## Author
|
|
99
|
+
|
|
100
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
OurSky
|
|
7
|
+
|
|
8
|
+
Fully merged Converged Node Platform API documentation
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: 1.3.0
|
|
11
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
12
|
+
|
|
13
|
+
Do not edit the class manually.
|
|
14
|
+
""" # noqa: E501
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__version__ = "1.3.0"
|
|
18
|
+
|
|
19
|
+
# import apis into sdk package
|
|
20
|
+
from ourskyai_node_platform_api.api.default_api import DefaultApi
|
|
21
|
+
|
|
22
|
+
# import ApiClient
|
|
23
|
+
from ourskyai_node_platform_api.api_response import ApiResponse
|
|
24
|
+
from ourskyai_node_platform_api.api_client import ApiClient
|
|
25
|
+
from ourskyai_node_platform_api.configuration import Configuration
|
|
26
|
+
from ourskyai_node_platform_api.exceptions import OpenApiException
|
|
27
|
+
from ourskyai_node_platform_api.exceptions import ApiTypeError
|
|
28
|
+
from ourskyai_node_platform_api.exceptions import ApiValueError
|
|
29
|
+
from ourskyai_node_platform_api.exceptions import ApiKeyError
|
|
30
|
+
from ourskyai_node_platform_api.exceptions import ApiAttributeError
|
|
31
|
+
from ourskyai_node_platform_api.exceptions import ApiException
|
|
32
|
+
|
|
33
|
+
# import models into sdk package
|
|
34
|
+
from ourskyai_node_platform_api.models.camera_status import CameraStatus
|
|
35
|
+
from ourskyai_node_platform_api.models.empty_success import EmptySuccess
|
|
36
|
+
from ourskyai_node_platform_api.models.focuser_position import FocuserPosition
|
|
37
|
+
from ourskyai_node_platform_api.models.focuser_status import FocuserStatus
|
|
38
|
+
from ourskyai_node_platform_api.models.mount_status import MountStatus
|
|
39
|
+
from ourskyai_node_platform_api.models.optical_tube_status import OpticalTubeStatus
|
|
40
|
+
from ourskyai_node_platform_api.models.relays_status import RelaysStatus
|
|
41
|
+
from ourskyai_node_platform_api.models.roof_status import RoofStatus
|
|
42
|
+
from ourskyai_node_platform_api.models.v1_filter_wheel_status import V1FilterWheelStatus
|
|
43
|
+
from ourskyai_node_platform_api.models.v1_get_component_status_response import V1GetComponentStatusResponse
|
|
44
|
+
from ourskyai_node_platform_api.models.v1_get_storage_status_response import V1GetStorageStatusResponse
|
|
45
|
+
from ourskyai_node_platform_api.models.v1_interface_info import V1InterfaceInfo
|
|
46
|
+
from ourskyai_node_platform_api.models.v1_mount_go_to_coordinates_request import V1MountGoToCoordinatesRequest
|
|
47
|
+
from ourskyai_node_platform_api.models.v1_network_interface import V1NetworkInterface
|
|
48
|
+
from ourskyai_node_platform_api.models.v1_post_alpaca_connection_event_request import V1PostAlpacaConnectionEventRequest
|
|
49
|
+
from ourskyai_node_platform_api.models.v1_safety_status import V1SafetyStatus
|
|
50
|
+
from ourskyai_node_platform_api.models.v1_update_network_interface_request import V1UpdateNetworkInterfaceRequest
|
|
51
|
+
from ourskyai_node_platform_api.models.weather_station_status import WeatherStationStatus
|