Skip to main content

Cross-platform system report with a local web dashboard (Windows, macOS, Linux).

Project description

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 / JSONsystemreports --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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

systemreports-2.0.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

systemreports-2.0.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file systemreports-2.0.0.tar.gz.

File metadata

  • Download URL: systemreports-2.0.0.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for systemreports-2.0.0.tar.gz
Algorithm Hash digest
SHA256 8a538cfdf8e0b4886cdc5df556d06e459b1a24d027cf9566cce3151262dfb999
MD5 d581dfbc9d429902ae9dd06c72e37a9b
BLAKE2b-256 87ce368d7d70af95dff6bfddd9fd7d859ac256c365a03a4c1680366972dd1660

See more details on using hashes here.

File details

Details for the file systemreports-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: systemreports-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for systemreports-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dac37db556e780159251e2bce91935a25cf6dff80c4ef2f9ccc380ecbb050d93
MD5 89cb3e4a09a1d8bb4474c460fb87a5ab
BLAKE2b-256 6e13b50111f5f2ab735b7a5a930615dc01e61298baa5413c4ca0a64fb45a7b01

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page