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.9.2.tar.gz (78.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.9.2-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.9.2.tar.gz
  • Upload date:
  • Size: 78.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.9.2.tar.gz
Algorithm Hash digest
SHA256 4c210189a2861ca5d4e5dfb92129d047f67b07e066dbe08f246f7889a5372eaf
MD5 2d6918dddc43924e6f70e40666da9d02
BLAKE2b-256 6df3a4793f98444df6763813509caaef20e371a07210fe485fe0c4d7eb9c9140

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 75325e4e4a52ae1321dfc150d7155c070a6d51db878c3d57fd2e627ea7c6a9bf
MD5 9d56ecc867f49c3db64c82ab358d3c0f
BLAKE2b-256 67a9192b04b0c48c2a26694b422a649f5b609e0d98766fa6fce49acc2f6e0e79

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