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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.7.tar.gz
  • Upload date:
  • Size: 73.3 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.7.tar.gz
Algorithm Hash digest
SHA256 029d167f707796f02e46f17c122c2197258ca28fe80c93bca879137c103abb42
MD5 61a8e78bd1fc280e1a2d9a73f92b9b01
BLAKE2b-256 ee500720749a0d7dabded4e1572ca6705c697a7071e4ccff4e7ad91222126600

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 40b11a1d9b3045ffa0f6b7dc7aba9cafe5680a36f1a2951715ca0d40a9008865
MD5 aa8d1c50fa1b127ef0abe5666fd09e25
BLAKE2b-256 e18d8e4b09e6620f1e4770bc74c9f58814156a3b4fb44e8ed53b263cee1eb466

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