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.4.2.tar.gz (72.9 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.4.2-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.2.tar.gz
  • Upload date:
  • Size: 72.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for lunatone_rest_api_client-0.4.2.tar.gz
Algorithm Hash digest
SHA256 2ce72acbe2ee4ccfef536b4cd3deaf4285f9341318d5f8eb6de8ee927dfca805
MD5 70c2a00b157fbd8385fbe4324229a9ed
BLAKE2b-256 ea4d3a222f852020800dc461c9d9bc064d7cc6e05120aaf56a386b01a53a71bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5871bce0a63de2ba844b4094cb130ec101937b71a940164d2f97ef5259618f60
MD5 ad9dec978faf05912d4393640d8c665a
BLAKE2b-256 8be77b0ca47a94707829f12f13c8ee6523555a82ab11c919d4ee0f4f41f54172

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