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.1.tar.gz (74.7 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.1-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.5.1.tar.gz
  • Upload date:
  • Size: 74.7 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.1.tar.gz
Algorithm Hash digest
SHA256 04dc93f5a7730d6593d4a576857ef8a75449aaf698185da4794e78684506010f
MD5 dc93c4f7d6b110c4b7bedd3588416b80
BLAKE2b-256 06f28212dfea94c164180e5f6abb20b40251506e03f6ec9606c41eaf0378fc3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31d43cef751223aed61f077d45b6cd47f23180b57a22864cab2be879b4bac6e4
MD5 fa30a76c5f50f38b83390e9ebcf1abbb
BLAKE2b-256 06ab291f9e063d35b814c8a9434458d6f48404eb5500cf21dc8cf9333136f724

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