pyninaapiio 0.0.20__tar.gz → 0.2.2.13.1__tar.gz

pyninaapiio-0.2.2.13.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: pyninaapiio
+Version: 0.2.2.13.1
+Summary: Python Wrapper for N.I.N.A. Advanced API
+Home-page: https://github.com/mawinkler/pyninaapiio
+Author: Markus Winkler
+Author-email: winkler.info@icloud.com
+License: MIT
+Keywords: N.I.N.A.,NinaAPI,Python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+License-File: LICENSE
+Requires-Dist: httpx
+Requires-Dist: attrs
+Requires-Dist: typeguard
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+Lightweight Python 3 module to receive data via API from N.I.N.A. Advanced API.

pyninaapiio-0.2.2.13.1/README.md

@@ -0,0 +1,50 @@
+# pyninaapiio
+
+Wrapper for the ***[N.I.N.A. Advanced API](https://github.com/christian-photo/ninaAPI)*** RESTful API. Designed to work with Home Assistant and the custom [NinaAPI](https://github.com/mawinkler/ninaapi) integration.
+
+## Functions
+
+The module exposes the following function:
+
+```python
+ninaapi = NinaAPI(
+    session,
+    base_url=entry.options.get(CONF_BASE_URL),
+    application_enabled=True,
+    camera_enabled=True,
+    dome_enabled=True,
+    filterwheel_enabled=True,
+    focuser_enabled=True,
+    guider_enabled=True,
+    image_enabled=True,
+    mount_enabled=True,
+    safety_monitor_enabled=True,
+    rotator_enabled=True,
+    switch_enabled=True,
+    weather_enabled=True,
+    api_timeout=10,
+)
+
+ninaapi.nina_info
+```
+
+This will return a handle to the NinaAPI class.
+
+## Setup
+
+```sh
+pip3 install .
+```
+
+## Build
+
+```sh
+python3 -m venv venv && source venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Test
+
+```sh
+python -m unittest -v tests/client.py
+```

pyninaapiio-0.2.2.13.1/pyninaapiio/advanced_api_client/api/application/get_application_get_tab.py

@@ -0,0 +1,144 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_application_get_tab_response_200 import GetApplicationGetTabResponse200
+from ...models.get_application_get_tab_response_400 import GetApplicationGetTabResponse400
+from ...models.unknown_error import UnknownError
+from ...types import Response
+
+
+def _get_kwargs() -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/application/get-tab",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = GetApplicationGetTabResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.BAD_REQUEST:
+        response_400 = GetApplicationGetTabResponse400.from_dict(response.json())
+
+        return response_400
+    if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
+        response_500 = UnknownError.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]]:
+    """Get Tab
+
+     Gets the current application tab
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[GetApplicationGetTabResponse200, GetApplicationGetTabResponse400, UnknownError]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

pyninaapiio-0.2.2.13.1/pyninaapiio/advanced_api_client/api/application/get_application_logs.py

@@ -0,0 +1,195 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_application_logs_level import GetApplicationLogsLevel
+from ...models.get_application_logs_response_200 import GetApplicationLogsResponse200
+from ...models.unknown_error import UnknownError
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    line_count: int,
+    level: Union[Unset, GetApplicationLogsLevel] = UNSET,
+) -> Dict[str, Any]:
+    params: Dict[str, Any] = {}
+
+    params["lineCount"] = line_count
+
+    json_level: Union[Unset, str] = UNSET
+    if not isinstance(level, Unset):
+        json_level = level.value
+
+    params["level"] = json_level
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/application/logs",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[GetApplicationLogsResponse200, UnknownError]]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = GetApplicationLogsResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
+        response_500 = UnknownError.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[GetApplicationLogsResponse200, UnknownError]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    line_count: int,
+    level: Union[Unset, GetApplicationLogsLevel] = UNSET,
+) -> Response[Union[GetApplicationLogsResponse200, UnknownError]]:
+    """Logs
+
+     Get a list of the last N log entries, this will ignore the header of the file. The endpoint is
+    limited by the log level set in NINA
+
+    Args:
+        line_count (int):
+        level (Union[Unset, GetApplicationLogsLevel]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[GetApplicationLogsResponse200, UnknownError]]
+    """
+
+    kwargs = _get_kwargs(
+        line_count=line_count,
+        level=level,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    line_count: int,
+    level: Union[Unset, GetApplicationLogsLevel] = UNSET,
+) -> Optional[Union[GetApplicationLogsResponse200, UnknownError]]:
+    """Logs
+
+     Get a list of the last N log entries, this will ignore the header of the file. The endpoint is
+    limited by the log level set in NINA
+
+    Args:
+        line_count (int):
+        level (Union[Unset, GetApplicationLogsLevel]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[GetApplicationLogsResponse200, UnknownError]
+    """
+
+    return sync_detailed(
+        client=client,
+        line_count=line_count,
+        level=level,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    line_count: int,
+    level: Union[Unset, GetApplicationLogsLevel] = UNSET,
+) -> Response[Union[GetApplicationLogsResponse200, UnknownError]]:
+    """Logs
+
+     Get a list of the last N log entries, this will ignore the header of the file. The endpoint is
+    limited by the log level set in NINA
+
+    Args:
+        line_count (int):
+        level (Union[Unset, GetApplicationLogsLevel]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[GetApplicationLogsResponse200, UnknownError]]
+    """
+
+    kwargs = _get_kwargs(
+        line_count=line_count,
+        level=level,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    line_count: int,
+    level: Union[Unset, GetApplicationLogsLevel] = UNSET,
+) -> Optional[Union[GetApplicationLogsResponse200, UnknownError]]:
+    """Logs
+
+     Get a list of the last N log entries, this will ignore the header of the file. The endpoint is
+    limited by the log level set in NINA
+
+    Args:
+        line_count (int):
+        level (Union[Unset, GetApplicationLogsLevel]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[GetApplicationLogsResponse200, UnknownError]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            line_count=line_count,
+            level=level,
+        )
+    ).parsed

pyninaapiio-0.2.2.13.1/pyninaapiio/advanced_api_client/api/application/get_application_plugins.py

@@ -0,0 +1,134 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.unknown_error import UnknownError
+from ...types import Response
+
+
+def _get_kwargs() -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/application/plugins",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[UnknownError]:
+    if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
+        response_500 = UnknownError.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[UnknownError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[UnknownError]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        UnknownError
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[UnknownError]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[UnknownError]:
+    """Plugins
+
+     Get a list of installed plugins. This is useful for example if you want to use an integrated plugin
+    like livestack or TPPA
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        UnknownError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed