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.4.tar.gz (75.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.5.4-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.5.4.tar.gz
  • Upload date:
  • Size: 75.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.5.4.tar.gz
Algorithm Hash digest
SHA256 3ab3d51407c9446ab44223a15489d7866595927759414b2b33a400597b2b8f9f
MD5 301fa619c38e883c925a6da9bea00ab7
BLAKE2b-256 a08b8ccfcbbb8874e369384fbd3e989d240217100112efd5e4dcc9d80647be6f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1d42891eb5a81dff28a51a560a8ed0c54de27c807422697e969395ab7a19a4e8
MD5 f0a582190e68de2b63a9b2ab24bae83f
BLAKE2b-256 3687d2292069e541c6d542d7bd3dbd313deb1a2d1dddbccef32a4e6c385a5723

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