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.4.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.4-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lunatone_rest_api_client-0.4.4.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.4.tar.gz
Algorithm Hash digest
SHA256 15fcfecfa4074eff20f2ba039aab3ac9380faf1f756e264d4081c71f97bbd117
MD5 a7d9c74069812238e87a94846a95ed07
BLAKE2b-256 0c8d4a7c8ec75217651a48705c41775637d1c3b458a13231b93006e77fd944d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lunatone_rest_api_client-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 abb454ccf009031710e4dc1cb05191ac7130ee5cf0a9d136e80fde1021044dbc
MD5 4bb1d241ce4aed5e5167f392ccf53186
BLAKE2b-256 239f3dffc0120a87a52b71aaa0720b8d0d01cc726df65de453fd04fc409e8206

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