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.6.3.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.6.3-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.6.3.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.6.3.tar.gz
Algorithm Hash digest
SHA256 c5db1ba51b93635f108d9e952f22e60754335213317e9938f953656793f29214
MD5 7154c4751590c6daddf5c4635e9abbf7
BLAKE2b-256 361302124e5db4d9790496698a3b2188a120bc0bc5b0c6c07cc3258958e060ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 54d60b46d0e18d9077d579c969521761ad39ef832c5308a487206c6502b1cffc
MD5 62afca32f5fb2954a59ef41e27d305c5
BLAKE2b-256 33c4f24f1596b36fb6d665a93d9bb69d44a97b5a7a25c16d00d5804cc41cb08d

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