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.1.tar.gz (76.0 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.1-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.6.1.tar.gz
  • Upload date:
  • Size: 76.0 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.1.tar.gz
Algorithm Hash digest
SHA256 b6a0ec3d2c9edb01fdcf9966d55c96bc503c563c06e89fbf79d3848b9035d238
MD5 f27c46adfe554374191f623a62f3cabd
BLAKE2b-256 552e079ec3ff7e2bfeb4ef300cbb29bc6d33ddd1ddf9b89cf537cf5de7a94225

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b319bbd1f21a74aeab22dcc0127201839a037d5f9d8c86741871da4ca6897628
MD5 84af0dbd9b020719251c5ddfcb16f126
BLAKE2b-256 64ab3644f997c84a2878037f9c2ed30630b7f217e5dfb07a3c7bdd87d4394ba7

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