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.7.0.tar.gz (76.2 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.7.0-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.7.0.tar.gz
  • Upload date:
  • Size: 76.2 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.7.0.tar.gz
Algorithm Hash digest
SHA256 744988fa534e104741a6fdf83650632f72dda70fd69e5be30e74a2ce6f09b325
MD5 17930b56b439fec02ca8b7fc16a94f0f
BLAKE2b-256 7076491039ef35c35b269ea721d526f2c42bdd193bab8a751f1b8d6e6ad34f22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d232b0061061b008edc53f8adf6458dc05333c37b6ecc901b7b3bedfb164582f
MD5 056beb31669522d29493363c3554fe2e
BLAKE2b-256 b5beef4526e41b76d89cd089cdeb8dad4d610cd055f6f0b1909384d1750d74d0

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