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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.5.2.tar.gz
  • Upload date:
  • Size: 75.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.5.2.tar.gz
Algorithm Hash digest
SHA256 827c3f241ea294a290e763281bd104df93d481981fcd1c64a37799d55612f0ea
MD5 a290ae24ab64fa49788d9263ffb6e6ed
BLAKE2b-256 6cf63170aad133868d9d30d3258c37bafdf6dc1466c1d30a9b0d70c7bf1e0a12

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4eea15503bd895efe9e97156ed42ca4ed899c6925af6253e81f84290ef1b65db
MD5 a20c792ffa4acb19b62e551c285e3c1f
BLAKE2b-256 9cfd586551673a8323217a1bacbcedffe4943c487d02587e214c741e76265b08

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