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.4.1.tar.gz (72.8 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.4.1-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.1.tar.gz
  • Upload date:
  • Size: 72.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for lunatone_rest_api_client-0.4.1.tar.gz
Algorithm Hash digest
SHA256 0e55541ea7ea89a75c2ad65342ff224af4775784aec46e2e99c98851b427f731
MD5 1207f0faef99eb424c8504a982d65e95
BLAKE2b-256 ffa9dc777d69a77e98e1407f3fd14cdc59e7eff7a9a73221b4c685450a937a8f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 25cbdaf904092b54b8f9ce9dc382249f7696a42ec2c05c150ffade659cc060b9
MD5 c25cd3529768606527002e4ce058ff84
BLAKE2b-256 1e4401ee56a01363f41b1f8208620e38a4c690885096e3980dfa0e80801f8e10

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