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.0.tar.gz (75.7 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.0-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.6.0.tar.gz
  • Upload date:
  • Size: 75.7 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.0.tar.gz
Algorithm Hash digest
SHA256 311fa73da3ffa6790d3cbd80c655ff8c7105aa400572cd4fb9726dd877621c84
MD5 a76c069cf578139078fd9c1c3145525b
BLAKE2b-256 c69efe93d6d2abdfa00852ba9bd0805630c11ecf74bffb93554d027ad2b42be4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5915ecccf0105380620d5b3a5c3e176a6b98cdd1bdc534ab4a3ad13148b5a57d
MD5 4842a5c513c6fa0486cbf01f8f62bbca
BLAKE2b-256 2b9290e128d65e7d255b7de360c908159c89a8d0975466f5a339d78f3a71c63f

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