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.6.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.6-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.5.6.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.6.tar.gz
Algorithm Hash digest
SHA256 b5efae4dffcc8af1e57d3bfce4d0ffd7af98a14f9aba3e150d910e88acf5e24a
MD5 b71ba89002912868ca879f148b21cf51
BLAKE2b-256 e5af0f9247fa0d790325b4a04985a97f7f5a1425f5f07684d63e7b8371656cef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 947dcbe6aeeb05a1b2e96fe0dc9d1c7ba1caa4a55973be3af17b4a2acebb70d5
MD5 bf5ff687c00cc015328fcf4f7594c68e
BLAKE2b-256 f240e8adb036abde72a84203a8019337b61c2da15d31881a871d3b3a6d5c3d95

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