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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.8.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.8.tar.gz
Algorithm Hash digest
SHA256 9f67c20d90545b4635befaf3c973f2a0bf6f2adc635badd6e7a21902cebfec34
MD5 a55f151e9455bf3d992d6d67bb4fdfbe
BLAKE2b-256 0ec80faaa599b26d2526639c3a75a4e69f85d20b239190dd29d2e4fd467873ee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 726e5ad83278462d2e37c545c19ea6bb10701848e2a9d4d1bc771b3df1887c03
MD5 180d2620d185f120266bf0328e4d005b
BLAKE2b-256 74385df2c5049237365673ef0a9e78a8a0d11daf99c34aa5b6426bf0da80b78a

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