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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.9.1.tar.gz
  • Upload date:
  • Size: 78.4 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.9.1.tar.gz
Algorithm Hash digest
SHA256 1a64f89f147322490295153d6b630a1015c8f608703a53128a84dc1c05906866
MD5 6e0bbb28b6052089e65b4b9b78942991
BLAKE2b-256 3007209942ba951a81eae7e60ca38b2766bc3808318d7a405cd3d9e4541af9df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f659dba77b0214122a9a695160e8efb09602d7019492c035970232a2e15f07e7
MD5 23415f339fb65e557073bf33f077995c
BLAKE2b-256 933534baa60ba3ef67b4d42fd3157badf359237b1706d2241c3a404612b8d7cc

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