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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.6.2.tar.gz
  • Upload date:
  • Size: 76.0 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.6.2.tar.gz
Algorithm Hash digest
SHA256 af104d46b48a22b51fbcda03bedbc3d202ec577ff8ec12b899d30a724c863b77
MD5 9c6eaaea26325cff061a576a7bdfb38b
BLAKE2b-256 4a9c122cf985d20c64020e59c87b8e37ccda5ae664f90b3d9f12eb0c1e2a659f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a3d8b4f63ecafe21bf6666be561e3d487cb7412831d8c9b08999bb0dd30b1daf
MD5 c17456d56eab8c00ed5638bd1e1a6283
BLAKE2b-256 de092c882ad0dddb11b00162f02de5900e48145514a2d4eb441ca3b0d9e2118a

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