Sysinfo

Cross-platform system inventory with modular collectors, redaction, and JSON/YAML/XML/HTML reports.

Install

pip install lupaxa-sysinfo
sysinfo --help

Features

• Lightweight defaults: basic host info as pretty-printed JSON
• Opt-in collectors: CPU, memory, disks, network, listening ports, processes, firewall, runtimes, GPU, packages
• Granular redaction for hosts, users, IPs, secrets, domains, and custom regexes
• Profiles for common workflows: minimal, ci, support
• JSON, YAML, XML, human summary, and compact HTML output (CLI)

Requirements

• Python 3.10+
• Runtime: psutil (plus distro on Linux; tldextract for PSL-aware redaction)

Library Quick Start

from lupaxa.sysinfo import collect_report

report = collect_report(cpu=True, memory=True)

Reports are plain dictionaries with schema_version and tool_version keys, ready for JSON serialisation. See the documentation for CollectOptions, RedactOptions, and profiles.

CLI Quick Start

sysinfo --version
sysinfo --profile ci --json report.json
sysinfo --all --yaml report.yaml
sysinfo --all --output xml
sysinfo --profile support --xml report.xml

You can also run the CLI as a module:

python -m lupaxa.sysinfo --help
python -m lupaxa.sysinfo --profile ci --json out.json

Development

From a clone of this repository:

make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test

Documentation

Site pages live in mkdocs/ and publish to https://sysinfo.thelupaxaproject.org/.

make init
make python-install-dev
make mkdocs-serve