Skip to main content

SystemReports

Cross-platform system metrics with a local web dashboard (Windows, macOS, Linux) and optional CLI/JSON output.

Screenshot

System report web dashboard

The UI shows CPU, memory, OS, disk (including I/O), network (interfaces, traffic, optional listening ports), top processes, and uptime. Use Refresh now or enable Auto-refresh to keep values current.

Features

  • Web dashboard — Run systemreports and open the URL in your browser (default: http://127.0.0.1:5050/).
  • CLI / JSON — systemreports --cli for a text summary; systemreports --json for full JSON.
  • Legacy — Original CentOS-oriented script: legacy_cli.py (Unix-oriented).

Requirements: Python 3.8+, psutil, Flask.

Install

pip install -e .
# or
pip install systemreports

Run the dashboard

systemreports

Other useful options:

# Do not open a browser automatically
systemreports --no-browser

# Listen on all interfaces (use only on trusted networks)
systemreports --host 0.0.0.0 --port 5050

API

  • GET /api/report — JSON snapshot (includes listening ports when permitted).
  • GET /api/report?ports=0 — Skip port enumeration (fewer permission prompts).

You can also run the module directly: python -m systemreports.

Publishing to PyPI

Use a dedicated virtualenv for releases if other tools pin an old packaging (for example some stacks require packaging<25).

python -m venv .venv-release
source .venv-release/bin/activate   # Windows: .venv-release\Scripts\activate
pip install --upgrade build twine packaging
python -m build
python -m twine check dist/*
python -m twine upload dist/*

If twine check / twine upload fails with unrecognized or malformed field license-file, upgrade packaging (and twine). Wheels use metadata 2.4; older packaging does not understand the License-File field. See pypa/twine#1216.

More detail

See README.rst for the original project notes and older pip/output examples.

Metadata

Release files for systemreports 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for systemreports 2.0.0
File Size Uploaded
systemreports-2.0.0.tar.gz 1.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for systemreports 2.0.0
File Interpreter ABI Platform
systemreports-2.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.1 MB

Release files / systemreports-2.0.0.tar.gz

Download URL systemreports-2.0.0.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
8a538cfdf8e0b4886cdc5df556d06e459b1a24d027cf9566cce3151262dfb999
BLAKE2b-256 checksum
How to use checksums
87ce368d7d70af95dff6bfddd9fd7d859ac256c365a03a4c1680366972dd1660
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release files / systemreports-2.0.0-py3-none-any.whl

Download URL systemreports-2.0.0-py3-none-any.whl
Size 16.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dac37db556e780159251e2bce91935a25cf6dff80c4ef2f9ccc380ecbb050d93
BLAKE2b-256 checksum
How to use checksums
6e13b50111f5f2ab735b7a5a930615dc01e61298baa5413c4ca0a64fb45a7b01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release history Release notifications | RSS feed

This release

2.0.0 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page