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.5.5.tar.gz (75.4 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.5.5-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.5.5.tar.gz
  • Upload date:
  • Size: 75.4 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.5.5.tar.gz
Algorithm Hash digest
SHA256 a76df8a7e1f154a84002ed7f8897778ffeceb9c89273e0a6ea417023bce71745
MD5 14dea5aa178a036c3a71711addc23b62
BLAKE2b-256 69e93f2c489cfa71fb8195d196886a18be861a4b9d25d6ba1146fb5520015cfb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0450cb794b8bfc47fd1026c517bc1d9eb1fa984098e8550e308eac4c2d60e8a8
MD5 466d676352db1d6714fa4cf47a789f62
BLAKE2b-256 fbb7bc95631488604879084d9c3f6e1eef4134718b5ccce1e9116c823d44688e

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