Skip to main content

Project Logo

The Lupaxa Developers Toolbox
Part of The Lupaxa Project


lupaxa-sysinfo

Cross-platform system inventory library and CLI: modular collectors, granular redaction, and JSON / YAML / XML / HTML reports.

Built for automation and support workflows used by The Lupaxa Project.

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
  • Output formats (CLI): JSON, YAML, XML, human summary, and compact HTML
  • Library API returns plain dictionaries with schema_version and tool_version
  • Fully typed, linted, formatted, and tested
  • MkDocs documentation included

Installation

From PyPI

pip install lupaxa-sysinfo

From source (development mode)

pip install -e ".[dev]"

Library quick start

from lupaxa.sysinfo import collect_report

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

For CollectOptions, RedactOptions, and profiles, see the documentation.

CLI quick start

sysinfo --help
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

Requirements

  • Python 3.10+
  • Runtime dependencies: psutil, PyYAML, tldextract (plus distro on Linux)

Documentation

Online documentation:

Documentation

Source repository:

GitHub

Serve docs locally

From a clone of the repository:

make mkdocs-serve

Then open the local URL printed by MkDocs in your browser.

Development

Clone the repository and install with Make:

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

Download files

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

Source Distribution

lupaxa_sysinfo-0.1.0.tar.gz (24.9 kB view details)

Uploaded Source

Built Distribution

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

lupaxa_sysinfo-0.1.0-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file lupaxa_sysinfo-0.1.0.tar.gz.

File metadata

  • Download URL: lupaxa_sysinfo-0.1.0.tar.gz
  • Upload date:
  • Size: 24.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lupaxa_sysinfo-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e4bd9eb2d467336eccd0c4e352a3dfec3f2d20f563fee9090920604ea675c172
MD5 c3ddea6ef6b84f71a03749ea99aed56b
BLAKE2b-256 3888907b1fd28d4f0cc93e4104b43614a5bead153c499bc1ba906d2a5ee493bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_sysinfo-0.1.0.tar.gz:

Publisher: generate-release.yml on lupaxa-developers-toolbox/sysinfo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lupaxa_sysinfo-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: lupaxa_sysinfo-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 26.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lupaxa_sysinfo-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a352b8dfabcfec24ed31b72cb1101a089379d0474655142b67da0fe158d11325
MD5 cc31301612a1d221ea2f22f043d2390c
BLAKE2b-256 38bf6d591e04400fb0574f85124380d894dbb80163775759dec2e3208a01eba0

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_sysinfo-0.1.0-py3-none-any.whl:

Publisher: generate-release.yml on lupaxa-developers-toolbox/sysinfo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.1

2 files

This release

0.1.0 This release

2 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