statz 1.1.0

Cross-platform system stats made easy

statz

statz is a cross-platform Python package that fetches real-time system usage and hardware specs — all wrapped in a simple, clean API.

Works on macOS, Linux, and Windows, and handles OS-specific madness under the hood so you don’t have to.

---

✨ Features

• 📊 Get real-time CPU, RAM, and disk usage
• 💻 Fetch detailed system specifications (CPU, RAM, OS, etc.)
• 🧠 Automatically handles platform-specific logic
• 🧼 Super clean API — just a few functions, no fluff

---

📦 Installation

pip install statz

---

💻 CLI Usage

statz comes with a powerful command-line interface that lets you get system information right from your terminal.

Basic Usage

# Get all system specs
statz --specs

# Get all system usage
statz --usage

# Get top processes
statz --processes

# Get temperature readings
statz --temp

# Launch live dashboard
statz --dashboard

Live Dashboard

The live dashboard provides real-time monitoring of your system with an interactive interface:

# Launch the dashboard
statz --dashboard

The dashboard displays:

• 📊 Real-time CPU usage per core
• 🧠 Memory usage and availability
• 💾 Disk I/O speeds
• 🌐 Network upload/download speeds
• 🔋 Battery status (if available)
• 🌡️ Temperature readings (if available)

Press Ctrl+C to exit the dashboard.

### Component-Specific Information

You can get information for specific components using these flags:

```bash
# Individual components
statz --specs --cpu        # CPU specifications
statz --specs --ram        # RAM information
statz --specs --disk       # Disk/storage info
statz --specs --gpu        # GPU information (Windows only)
statz --specs --network    # Network adapter info
statz --specs --battery    # Battery information
statz --specs --os         # Operating system info

# Combine multiple components
statz --specs --cpu --ram --disk
statz --usage --cpu --ram --network

Process Monitoring

# Get top 5 processes by CPU usage (default)
statz --processes

# Get top 10 processes by CPU usage
statz --processes --process-count 10

# Get top 5 processes by memory usage
statz --processes --process-type mem

# Get top 15 processes by memory usage
statz --processes --process-count 15 --process-type mem

Output Formats

# JSON output
statz --specs --json
statz --usage --cpu --ram --json

# Export to file
statz --specs --out
statz --usage --processes --out

Available Flags

Flag	Description
--specs	Get system specifications
--usage	Get real-time system usage
--processes	Get top processes information
--temp	Get temperature readings
--dashboard	Launch live monitoring dashboard
--os	Operating system information
--cpu	CPU information
--gpu	GPU information (Windows only)
--ram	RAM/memory information
--disk	Disk/storage information
--network	Network adapter information
--battery	Battery information
--json	Output in JSON format
--out	Export to JSON file
--process-count N	Number of processes to show (default: 5)
--process-type {cpu,mem}	Sort processes by CPU or memory usage

Examples

# Get CPU and RAM specs in JSON format
statz --specs --cpu --ram --json

# Monitor top 10 memory-intensive processes
statz --processes --process-count 10 --process-type mem

# Get all usage data and export to file
statz --usage --out

# Get system temperatures and CPU usage
statz --temp --usage --cpu

# Get complete system overview
statz --specs --usage --processes --temp

# Launch interactive dashboard for real-time monitoring
statz --dashboard

---

PyPi Project 🐍

Github Repository 🧑‍💻

📝 Changelog

v1.1.0 – Performance Improvements 🚀

• Selective Fetching for System Specs 🛠️
  • Improved performance by allowing selective fetching of system specifications.
  • Added support for fetching only requested components (e.g., CPU, RAM, Disk) to avoid unnecessary computations.
• Enhanced CLI Integration 💻
  • Updated CLI to support selective fetching flags for --specs and --usage.
  • Improved error handling and default values for missing or unsupported components.
• Refactored Platform-Specific Functions 🧹
  • Updated _get_windows_specs, _get_linux_specs, and _get_mac_specs to handle selective fetching.
  • Added meaningful error messages and default values for null or missing data.
• Documentation Updates 📚
  • Updated docstrings across platform-specific functions to reflect performance improvements.

📝 Side Note

If you find any errors on Linux, please report them to me with as much detail as possible as I do not have a Linux machine.