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.6.tar.gz (73.3 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.6-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.6.tar.gz
  • Upload date:
  • Size: 73.3 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.6.tar.gz
Algorithm Hash digest
SHA256 2d7c26425c302232866172a35c841b0172050e8c5523b0e1753b72c5a5a7841f
MD5 c1eab46dfb28966fa42bcc1217d70c83
BLAKE2b-256 d44750275389263e2665b83dda75a179393b48391ff49ae517095b9c3aaee212

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a8d9b295f15c11a60ef4c9c4a85a869ec551a479194fbacc7512efc77653ba0f
MD5 4e848b5841bb0f46861751e670b29e6a
BLAKE2b-256 4e8576998081cfd651b4cc0f2bfc79de16a1d968eb044fac3248c96b399a0a68

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