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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.7.1.tar.gz
  • Upload date:
  • Size: 76.6 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.7.1.tar.gz
Algorithm Hash digest
SHA256 1cf613f1bdebd5ff2402a279d0e495166754ab9e0833af290888fd1ff767408a
MD5 28ed4950b7803de4add45ca5c3bfc52f
BLAKE2b-256 88162e197f57830c3c0d5dfc54ba6d8b2b91f15ac0d0a8863e4a0e66673795f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aeac786bb915e9405c5f37c371f980bf42a65bd9b8209853eb6d8976b93a72af
MD5 a11d30001de3fcfca87e0068bad070b7
BLAKE2b-256 8ad05b9337137c5c1d15f5b2595df00f2e35a49b0930af9dcaed52f2de744d5d

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