Skip to main content

A client library for accessing the Lunatone REST API

Project description

Lunatone REST API Client

lunatone-rest-api-client is a Python package providing access to the Lunatone REST API.

It includes async clients for Lunatones REST API endpoints.

The following devices are supported:

Installation

Use pip to install the latest stable version of lunatone-rest-api-client

pip install --upgrade lunatone-rest-api-client

The current development version is available on [GitLab.com] (https://gitlab.com/lunatone-public/lunatone-rest-api-client) and can be installed directly from the git repository:

pip install git+https://gitlab.com/lunatone-public/lunatone-rest-api-client.git

Usage

import asyncio

import aiohttp

from lunatone_rest_api_client import Auth, Devices


async def main() -> None:
    """Show example of fetching devices."""
    async with aiohttp.ClientSession() as session:
        auth = Auth(session, "http://10.0.0.31")
        devices = Devices(auth)
        await devices.async_update()
        print(devices.data)


if __name__ == "__main__":
    asyncio.run(main())

Setting up development environment

This Python project is fully managed using the uv dependency manager.

Requirements:

To install all packages, including all development requirements:

uv sync

To run just the Python tests:

uv run pytest

Scripts

API tests:

This script sends a POST request and right after two GET requests to check if the status is changed immediately.

uv run ./scripts/api_tests.py --ip <ip-address>

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

lunatone_rest_api_client-0.4.5.tar.gz (73.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lunatone_rest_api_client-0.4.5-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file lunatone_rest_api_client-0.4.5.tar.gz.

File metadata

  • Download URL: lunatone_rest_api_client-0.4.5.tar.gz
  • Upload date:
  • Size: 73.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for lunatone_rest_api_client-0.4.5.tar.gz
Algorithm Hash digest
SHA256 db7ff1ec11a39f3b5da3dcb37e9e0f62b53ed2e372fde75902c6c8f09b09068c
MD5 673f915decd77b92c746215c0625821c
BLAKE2b-256 011254086e870b04d245f9374d9e916a49483be9ab6604efbb491af64cd24b5b

See more details on using hashes here.

File details

Details for the file lunatone_rest_api_client-0.4.5-py3-none-any.whl.

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7d7ad8aebe6c90bd7ae81103345b22f6c273858f43c849a9d455902336c094ca
MD5 b3e51ceb1db5b46dc5fc3b125b169eb1
BLAKE2b-256 4a1bc4b8e9b24557bcc665477457a86b32b27e5c70b26ad09ad84a3619edbc57

See more details on using hashes here.

Supported by

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