yamon 0.1.0__tar.gz

yamon-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 grapeot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

yamon-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+recursive-include yamon/static *
+recursive-include frontend/dist *
+

yamon-0.1.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: yamon
+Version: 0.1.0
+Summary: Visually pleasing, deep system monitoring for macOS
+Author: grapeot
+License: MIT
+Keywords: macos,monitoring,apple-silicon,system-monitor,performance
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psutil<6.0.0,>=5.9.0
+Requires-Dist: fastapi<1.0.0,>=0.104.0
+Requires-Dist: uvicorn[standard]<1.0.0,>=0.24.0
+Requires-Dist: websockets<13.0.0,>=12.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Yamon 🍊
+
+**Beautiful, In-Depth System Monitoring for macOS.**
+
+Yamon is a modern system monitor engineered specifically for Apple Silicon. It goes beyond standard CPU and RAM metrics to reveal the true heartbeat of your Mac — from Neural Engine activity to precise component-level power consumption — all displayed in an elegant, real-time web interface.
+
+![Yamon Screenshot](docs/screenshot.jpg)
+
+## ✨ Features
+
+### 🚀 Deep Apple Silicon Integration
+Unlock metrics that standard tools often hide:
+- **Total System Power**: Accurate, real-time power readings (mW) derived directly from the SMC (System Management Controller).
+- **Power Breakdown**: visualize exactly how much energy your CPU, GPU, and Neural Engine are consuming.
+- **Neural Engine (ANE) Usage**: Track utilization of dedicated AI hardware.
+- **GPU Frequency & Usage**: Gain granular insights into graphics performance and clock speeds.
+
+### ⚡️ Real-Time & Responsive
+- **Millisecond Latency**: Powered by WebSockets for an instant, lag-free monitoring experience.
+- **Historical Context**: Interactive charts visualize the last 2 minutes of performance data.
+- **Modern UI**: Built with React, TypeScript, and ECharts for a premium, responsive aesthetic on any device.
+
+### 🛠️ Native Performance, Pure Python
+- **Native APIs via ctypes**: Directly interfaces with macOS `IOReport` and `SMC` private frameworks.
+- **No Heavy Dependencies**: Pure Python implementation without the need for compiling Rust or C/C++ binaries.
+- **No Sudo Required**: Most metrics, including granular Power and GPU stats, function without root privileges.*
+
+## 📦 Installation
+
+### Install from PyPI (Recommended)
+
+```bash
+pip install yamon
+```
+
+After installation, start the monitor:
+```bash
+yamon
+```
+
+Visit **http://localhost:8000** to view your dashboard.
+
+### Install from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/grapeot/yamon.git
+cd yamon
+
+# Install in development mode
+pip install -e .
+```
+
+## 📸 Usage
+
+### Production Mode (Single Server)
+The most convenient way to run Yamon locally. The backend serves both the API and the compiled frontend.
+
+```bash
+# 1. Build Frontend
+./build_frontend.sh
+
+# 2. Run Backend
+./run_backend.sh
+```
+Visit **http://localhost:8000** to access the dashboard.
+
+### Development Mode (Separate Frontend & Backend)
+For contributors who want to modify the frontend code.
+
+```bash
+# 1. Run Backend (Collects data)
+./run_backend.sh
+
+# 2. Run Frontend (Hot-reload dev server)
+./run_frontend.sh
+```
+Visit **http://localhost:5173** for the development server.
+
+## 🏗️ Architecture
+
+Yamon bridges the gap between low-level hardware counters and high-level visualization:
+
+1.  **Collectors (Python)**: Low-overhead bindings to Apple's private frameworks (`IOKit`, `IOReport`).
+2.  **Server (FastAPI)**: Aggregates metrics and broadcasts them via efficient WebSocket streams.
+3.  **Frontend (React)**: High-performance canvas rendering for dense data visualization.
+
+## 🔋 Power Monitoring Accuracy
+Yamon leverages the `mach_task_self()` iteration method to interface with the hardware SMC. This allows it to read the **System Total Power (PSTR)** sensor with high precision, bypassing standard permission restrictions found in other tools.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+*Note: While Yamon is designed to run without root, some deeply protected system metrics may unavailable without elevated privileges. The application will degrade gracefully in these cases.*

yamon-0.1.0/README.md

@@ -0,0 +1,96 @@
+# Yamon 🍊
+
+**Beautiful, In-Depth System Monitoring for macOS.**
+
+Yamon is a modern system monitor engineered specifically for Apple Silicon. It goes beyond standard CPU and RAM metrics to reveal the true heartbeat of your Mac — from Neural Engine activity to precise component-level power consumption — all displayed in an elegant, real-time web interface.
+
+![Yamon Screenshot](docs/screenshot.jpg)
+
+## ✨ Features
+
+### 🚀 Deep Apple Silicon Integration
+Unlock metrics that standard tools often hide:
+- **Total System Power**: Accurate, real-time power readings (mW) derived directly from the SMC (System Management Controller).
+- **Power Breakdown**: visualize exactly how much energy your CPU, GPU, and Neural Engine are consuming.
+- **Neural Engine (ANE) Usage**: Track utilization of dedicated AI hardware.
+- **GPU Frequency & Usage**: Gain granular insights into graphics performance and clock speeds.
+
+### ⚡️ Real-Time & Responsive
+- **Millisecond Latency**: Powered by WebSockets for an instant, lag-free monitoring experience.
+- **Historical Context**: Interactive charts visualize the last 2 minutes of performance data.
+- **Modern UI**: Built with React, TypeScript, and ECharts for a premium, responsive aesthetic on any device.
+
+### 🛠️ Native Performance, Pure Python
+- **Native APIs via ctypes**: Directly interfaces with macOS `IOReport` and `SMC` private frameworks.
+- **No Heavy Dependencies**: Pure Python implementation without the need for compiling Rust or C/C++ binaries.
+- **No Sudo Required**: Most metrics, including granular Power and GPU stats, function without root privileges.*
+
+## 📦 Installation
+
+### Install from PyPI (Recommended)
+
+```bash
+pip install yamon
+```
+
+After installation, start the monitor:
+```bash
+yamon
+```
+
+Visit **http://localhost:8000** to view your dashboard.
+
+### Install from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/grapeot/yamon.git
+cd yamon
+
+# Install in development mode
+pip install -e .
+```
+
+## 📸 Usage
+
+### Production Mode (Single Server)
+The most convenient way to run Yamon locally. The backend serves both the API and the compiled frontend.
+
+```bash
+# 1. Build Frontend
+./build_frontend.sh
+
+# 2. Run Backend
+./run_backend.sh
+```
+Visit **http://localhost:8000** to access the dashboard.
+
+### Development Mode (Separate Frontend & Backend)
+For contributors who want to modify the frontend code.
+
+```bash
+# 1. Run Backend (Collects data)
+./run_backend.sh
+
+# 2. Run Frontend (Hot-reload dev server)
+./run_frontend.sh
+```
+Visit **http://localhost:5173** for the development server.
+
+## 🏗️ Architecture
+
+Yamon bridges the gap between low-level hardware counters and high-level visualization:
+
+1.  **Collectors (Python)**: Low-overhead bindings to Apple's private frameworks (`IOKit`, `IOReport`).
+2.  **Server (FastAPI)**: Aggregates metrics and broadcasts them via efficient WebSocket streams.
+3.  **Frontend (React)**: High-performance canvas rendering for dense data visualization.
+
+## 🔋 Power Monitoring Accuracy
+Yamon leverages the `mach_task_self()` iteration method to interface with the hardware SMC. This allows it to read the **System Total Power (PSTR)** sensor with high precision, bypassing standard permission restrictions found in other tools.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+*Note: While Yamon is designed to run without root, some deeply protected system metrics may unavailable without elevated privileges. The application will degrade gracefully in these cases.*