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.3.tar.gz (72.9 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.3-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.3.tar.gz
  • Upload date:
  • Size: 72.9 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.3.tar.gz
Algorithm Hash digest
SHA256 06e5ac36959597f4aa8419b8e9f047bf1c4c7f61b9a06d713088214127cd541b
MD5 0f3e9411cce15a4f578d6aec93bf6a5a
BLAKE2b-256 3f225183e4d58ac4d1cde346680fa165ab22539469617483b7740b72191b72e2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 41e18b091879c67b182e0e4057e3fa2d7ce7447fb1be73afef98e1747257fc42
MD5 0c8fb56addbc772b2bca00288b7dc5d4
BLAKE2b-256 f21ebada46febd1af6d899a713df40c5101bb183a48ed94290977abb86ecb384

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