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.5.7.tar.gz (75.5 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.5.7-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lunatone_rest_api_client-0.5.7.tar.gz
Algorithm Hash digest
SHA256 14a209474e3dad69263e35872e0b56b97b2a14beca52a0a5b89eee77e74519fd
MD5 cde18fa58e663fc751158cd6a6ca533e
BLAKE2b-256 3fdfc030f9c8ebf37ac39c468cd8fe48f0d2554a12d507a1c3dfddddf4f00769

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1f863e86ef2d5af36f0da38758dac9dfe8c18c9f23d1c2fceefe193c816da9b7
MD5 d63780819e9ca2bf47e7857fead40e46
BLAKE2b-256 526c2f423fe1f3640acf250a6cfa8cbfa7e69bd23b5116c4d969a5af3a3b5953

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