Metadata-Version: 2.2
Name: librehardwaremonitor-api
Version: 1.0.0
Summary: A Python API client for LibreHardwareMonitor
Home-page: https://github.com/Sab44/librehardwaremonitor-api
Author: Sab44
Author-email: 64696149+Sab44@users.noreply.github.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: aiohttp
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# LibreHardwareMonitor API Client
A Python library for interacting with the LibreHardwareMonitor API.

## Overview
This library provides a simple interface for fetching data from the API provided by the inbuilt LibreHardwareMonitor web server.

## Methods
The library provides two callable methods:

* `get_data_json`: Returns the unmodified `data.json` response from the LibreHardwareMonitor API as dict.
* `get_hardware_device_names`: Returns a list of all hardware device names in the computer.

## Installation
To install the library, run the following command:
```bash
pip install librehardwaremonitor-api
```

## Usage
```
import asyncio
from librehardwaremonitor_api import LibreHardwareMonitorClient

async def main():
    client = LibreHardwareMonitorClient("<HOSTNAME OR IP ADDRESS>", <PORT>)
    
    data_json = await client.get_data_json()
    print(data_json)
    
    device_names = await client.get_hardware_device_names()
    print(device_names)

asyncio.run(main())
```

## TODO
* implement basic auth
