pilibre 0.1.0

Description:

pilibre 0.1.0

A small Python script for displaying hardware metrics. Metrics are pulled from LibreHardwareMonitor, and requires it to be installed on your PC and in server mode. It is designed to be run on a small computer with a small display. I intend to use a Raspberry Pi, but you could likely use something else.


Installation
PiLibre relies on rich and httpx on the display machine, and LibreHardwareMonitor on the machine from which you want to see metrics.

rich: For terminal display of the hardware metrics
https: To pull the JSON data served by LibreHardwareMonitor
LibreHardwareMonitor: For getting the hardware metrics of your computer.

Host Machine Setup
The host machine only needs to have LibreHardwareMonitor installed. The project can be found here: https://github.com/LibreHardwareMonitor/LibreHardwareMonitor and downloaded from here: https://github.com/LibreHardwareMonitor/LibreHardwareMonitor/releases.
Once installed:

Open the HTTP server via Options -> HTTP Server.
Take note of the IP address. This is the IP address of the local machine.
If you'd like to change the default port, do so here.

Display Machine Setup
The machine you want to display metrics on needs to have the PiLibre application installed. The easiest way is to use pipx, but manual instructions are also included.
pipx
pipx is recommended for the simplest installation. This will install PiLibre into its own virtual environment, along with any dependencies.
Install pipx from here: https://github.com/pypa/pipx#install-pipx.
pipx install git+https://github.com/acbuie/pilibre.git

Manually
If you know what you're doing, you can install the package via Git and run it manually, with python -m src/pilibre. As always, a virtual environment is recommended, so the requirements don't get installed into the system python. Runtime dependencies can be installed with python -m pip install requirements.txt.
First, clone the project into a new directory.
mkdir pilibre
cd pilibre
git clone https://github.com/acbuie/pilibre.git

Once installed, create and activate a python virtual environment. Read about python virtual environments here: https://docs.python.org/3/tutorial/venv.html.
Then, install the dependencies.
python -m pip install requirements.txt

Usage
Usage is very simple. Once the HTTP server is running on the host machine, simply specify the IP address and port in the config file and run the project.