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.8.0.tar.gz (77.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.8.0-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.8.0.tar.gz
  • Upload date:
  • Size: 77.8 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.8.0.tar.gz
Algorithm Hash digest
SHA256 23b2de987d340c01c21954af761f3bdeac8d9419687b5e57e20fd2559395a65f
MD5 6c2554612104e66716142e8d967165fb
BLAKE2b-256 71433a8b7f0e1dad7f57955febd53e067634169fc00541a128a62b8c1ccd04ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fe82c4d858b56dbfef0f2bb7dc370a9da8fd287f4c65e93f109d471194e6e89d
MD5 49f9e0c4caa37a86a68921474732a9bf
BLAKE2b-256 54b3e91eb861533a7ee98de71fccbbea7390a98a379ad91aa0fc2eaba84a0e17

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