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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.9.0.tar.gz
  • Upload date:
  • Size: 78.1 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.0.tar.gz
Algorithm Hash digest
SHA256 2c1cd1d8c8ae51d85c832d8e12681f65ea580e86cc888910809cc583acaf8808
MD5 a7ed52f74a5389a0fd224bfb460dca96
BLAKE2b-256 b30cd5bad8914e26bf4e390b5492802eaac207450a87016f36da123cfc978759

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e06b8aec736aedebdba58876624f5a150deef8ee500e6690d8d46dab345baf36
MD5 c4ecc2c9b6f04c8c4c1eca41b914002f
BLAKE2b-256 68f4bccc93d777c736dcb447f6617f60abb6abb9e91f77f4f30a5dc69bca740b

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