SystemDetector

A cross-platform system and hardware information collector for Python. The package gathers data on the CPU, memory, disks, network, Bluetooth, firmware, GPU, battery, operating system, and Python version.

Project status: alpha (0.0.1). Data collection is performed to the best of its ability, and some fields may be None, 0, or empty lists when the system does not provide certain information.

Requirements

• Python 3.9 or higher
• psutil, installed automatically
• Windows: the windows extra installs WMI for additional hardware queries

The package also uses native tools when available, such as PowerShell, bluetoothctl, lspci, system_profiler, pmset, and files from /sys and /proc on Linux. The absence of these tools does not prevent the package from being imported, but may reduce the amount of information collected.

Instalation

GitHub

pip install git+https://github.com/PlayGames-2020/SystemDetector.git

or

pip install git+https://github.com/PlayGames-2020/SystemDetector.git@main

Quick Start

from SystemDetector.detector import SystemDetector


detector = SystemDetector()

cpu = detector.get_cpu_info()
print(f"CPU: {cpu.Brand or 'Desconhecida'}")
print(f"Uso: {cpu.Usage:.1f}%")

memory = detector.get_memory_info()
print(f"RAM total: {memory.Total} bytes")

snapshot = detector.get_all_info
print(snapshot["OS"])

The class accepts an optional TTL for the internal cache:

from SystemDetector.detector import SystemDetector


detector = SystemDetector(ttl_seconds=10)
# Clears all values ​​stored in the cache when necessary.
detector.clear_cache()

Singleton access compatible with the legacy API is also available:

from SystemDetector.detector import ConfigSystemDetector


detector = ConfigSystemDetector()

Main API

All of the methods listed below return dataclasses defined in SystemDetector.metadata, except for methods that return lists or dictionaries.

The PascalCase names from the legacy API are still available, for example GetCPUInfo(), GetMemoryInfo(), GetAllDisks(), and GetAllInfo().

Snapshot Structure

get_all_info() returns a dictionary with these keys:

OS, CPU, Memory, Disks, Network, BIOS, Motherboard,
GPU, Battery, Bluetooth, Python

To convert a single dataclass into a dictionary:

cpu_dict = detector.get_cpu_info().as_dict()

The main metrics are:

• CPU: frequency in MHz, usage and temperature in percentage and degrees Celsius
• Memory and disks: bytes
• GPU: memory in bytes when available
• Battery: percentage from 0 to 100 and voltage in volts when available
• Uptime: seconds since startup

Notes on networking and privacy

get_network_info() attempts to determine the local IP address via a UDP connection and checks Internet availability with a TCP connection to 8.8.8.8:53. This check may take a few seconds or fail on restricted networks.

The package does not send the collected data to an external service; the result is returned only to the code that calls the methods. Nevertheless, applications that expose or store the snapshot should treat fields such as serial numbers and network addresses as potentially sensitive data.

Development and Testing

The tests are located in tests/ and use mocks so they do not depend on actual hardware, system commands, or a network connection.

python -m unittest discover -s tests -v

If the development add-on is installed, you can also run:

python -m pytest

License

Distributed under the license MIT.

Links

• Repository
• Documentation