lupaxa-sysinfo 0.1.0__tar.gz

lupaxa_sysinfo-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+# OS
+.DS_Store
+
+# Cursor
+.superpowers/
+.worktrees/
+cursor-docs
+
+# Make
+.makefiles/
+
+# MkDocs
+site/
+
+# Python
+.venv/
+__pycache__/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+build/
+*.egg-info/

lupaxa_sysinfo-0.1.0/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 The Lupaxa Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lupaxa_sysinfo-0.1.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.5
+Name: lupaxa-sysinfo
+Version: 0.1.0
+Summary: Cross-platform system inventory library and CLI with modular collectors, redaction, and JSON/YAML/XML/HTML reports.
+Project-URL: Homepage, https://github.com/lupaxa-developers-toolbox/sysinfo
+Project-URL: Repository, https://github.com/lupaxa-developers-toolbox/sysinfo
+Project-URL: Issues, https://github.com/lupaxa-developers-toolbox/sysinfo/issues
+Project-URL: Documentation, https://sysinfo.thelupaxaproject.org/
+Author: The Lupaxa Project
+License: MIT License
+        
+        Copyright (c) 2026 The Lupaxa Project
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENCE
+Keywords: cli,inventory,psutil,sysinfo,system-info
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: distro>=1.8; sys_platform == 'linux'
+Requires-Dist: psutil>=5.9
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tldextract>=5.0
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
+Requires-Dist: hatch>=1.12.0; extra == 'dev'
+Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
+Requires-Dist: mkdocs==1.6.1; extra == 'dev'
+Requires-Dist: mypy>=1.12.0; extra == 'dev'
+Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+<!-- markdownlint-disable -->
+<p align="center">
+  <a href="https://github.com/lupaxa-developers-toolbox">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
+  </a>
+</p>
+<h3 align="center">
+  The Lupaxa Developers Toolbox<br />
+  Part of The Lupaxa Project
+</h3>
+
+<br />
+
+# 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
+
+```bash
+pip install lupaxa-sysinfo
+```
+
+### From source (development mode)
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Library quick start
+
+```python
+from lupaxa.sysinfo import collect_report
+
+report = collect_report(cpu=True, memory=True)
+```
+
+For `CollectOptions`, `RedactOptions`, and profiles, see the
+[documentation](https://sysinfo.thelupaxaproject.org/).
+
+## CLI quick start
+
+```bash
+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:
+
+```bash
+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](https://sysinfo.thelupaxaproject.org/)
+
+Source repository:
+
+[GitHub](https://github.com/lupaxa-developers-toolbox/sysinfo)
+
+### Serve docs locally
+
+From a clone of the repository:
+
+```bash
+make mkdocs-serve
+```
+
+Then open the local URL printed by MkDocs in your browser.
+
+## Development
+
+Clone the repository and install with Make:
+
+```bash
+make init                # first-time makefile-skills checkout
+make python-install-dev  # editable install with [dev]
+make python-check        # lint, type-check, and test
+```
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_sysinfo-0.1.0/README-PYPI.md

@@ -0,0 +1,114 @@
+<!-- markdownlint-disable -->
+<p align="center">
+  <a href="https://github.com/lupaxa-developers-toolbox">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
+  </a>
+</p>
+<h3 align="center">
+  The Lupaxa Developers Toolbox<br />
+  Part of The Lupaxa Project
+</h3>
+
+<br />
+
+# 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
+
+```bash
+pip install lupaxa-sysinfo
+```
+
+### From source (development mode)
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Library quick start
+
+```python
+from lupaxa.sysinfo import collect_report
+
+report = collect_report(cpu=True, memory=True)
+```
+
+For `CollectOptions`, `RedactOptions`, and profiles, see the
+[documentation](https://sysinfo.thelupaxaproject.org/).
+
+## CLI quick start
+
+```bash
+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:
+
+```bash
+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](https://sysinfo.thelupaxaproject.org/)
+
+Source repository:
+
+[GitHub](https://github.com/lupaxa-developers-toolbox/sysinfo)
+
+### Serve docs locally
+
+From a clone of the repository:
+
+```bash
+make mkdocs-serve
+```
+
+Then open the local URL printed by MkDocs in your browser.
+
+## Development
+
+Clone the repository and install with Make:
+
+```bash
+make init                # first-time makefile-skills checkout
+make python-install-dev  # editable install with [dev]
+make python-check        # lint, type-check, and test
+```
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_sysinfo-0.1.0/README.md

@@ -0,0 +1,82 @@
+<p align="center">
+  <a href="https://github.com/lupaxa-developers-toolbox">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Developers Toolbox" />
+  </a>
+</p>
+
+<h1 align="center">sysinfo</h1>
+
+Cross-platform system inventory with modular collectors, redaction, and JSON/YAML/XML/HTML reports.
+
+<p align="center">
+  <a href="https://sysinfo.thelupaxaproject.org/">Documentation</a>
+  ·
+  <a href="https://github.com/lupaxa-developers-toolbox/sysinfo">GitHub</a>
+</p>
+
+## Install
+
+```bash
+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
+
+```python
+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](https://sysinfo.thelupaxaproject.org/) for `CollectOptions`,
+`RedactOptions`, and profiles.
+
+## CLI quick start
+
+```bash
+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:
+
+```bash
+python -m lupaxa.sysinfo --help
+python -m lupaxa.sysinfo --profile ci --json out.json
+```
+
+## Development
+
+From a clone of this repository:
+
+```bash
+make init                # first-time makefile-skills checkout
+make python-install-dev  # editable install with [dev]
+make python-check        # lint, type-check, and test
+make mkdocs-serve        # after skills are installed
+```
+
+Community standards (code of conduct, contributing, security) are in [`docs/`](docs/).
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_sysinfo-0.1.0/docs/README.md

@@ -0,0 +1,23 @@
+<p align="center">
+    <a href="https://github.com/lupaxa-developers-toolbox">
+        <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Organisation Logo" />
+    </a>
+</p>
+
+<h1 align="center">Core Documentation</h1>
+
+The following documents define the standards that apply across **The Lupaxa Project**:
+
+| Document                              | Purpose                                                           |
+| :------------------------------------ | :---------------------------------------------------------------- |
+| [Code of Conduct](CODE_OF_CONDUCT.md) | Expected behaviour and reporting procedures.                      |
+| [How to Contribute](CONTRIBUTING.md)  | Development workflow, coding standards, and contribution process. |
+| [Governance](GOVERNANCE.md)           | Project governance, roles, and decision-making.                   |
+| [Maintainers](MAINTAINERS.md)         | Maintainer responsibilities and expectations.                     |
+| [Projects Overview](PROJECTS.md)      | Overview of organisations, repositories, and project structure.   |
+| [Security Policy](SECURITY.md)        | Responsible disclosure and secure development practices.          |
+| [Support Guide](SUPPORT.md)           | How to obtain help and support.                                   |
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_sysinfo-0.1.0/pyproject.toml

@@ -0,0 +1,156 @@
+[build-system]
+requires = ["hatchling>=1.18"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lupaxa-sysinfo"
+dynamic = ["version"]
+description = "Cross-platform system inventory library and CLI with modular collectors, redaction, and JSON/YAML/XML/HTML reports."
+readme = "README-PYPI.md"
+license = { file = "LICENCE" }
+requires-python = ">=3.10"
+
+authors = [
+  { name = "The Lupaxa Project" }
+]
+
+keywords = ["sysinfo", "system-info", "inventory", "cli", "psutil"]
+
+dependencies = [
+  "psutil>=5.9",
+  "distro>=1.8; sys_platform == 'linux'",
+  "tldextract>=5.0",
+  "PyYAML>=6.0",
+]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: System :: Systems Administration",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Utilities",
+]
+
+[project.urls]
+Homepage = "https://github.com/lupaxa-developers-toolbox/sysinfo"
+Repository = "https://github.com/lupaxa-developers-toolbox/sysinfo"
+Issues = "https://github.com/lupaxa-developers-toolbox/sysinfo/issues"
+Documentation = "https://sysinfo.thelupaxaproject.org/"
+
+[project.scripts]
+sysinfo = "lupaxa.sysinfo.cli:main"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+  "ruff>=0.6.0",
+  "mypy>=1.12.0",
+  "hatch>=1.12.0",
+  "bump-my-version>=1.2.0",
+  "pip-audit>=2.7.0",
+  "mkdocs==1.6.1",
+  "mkdocs-material==9.7.7",
+]
+test = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+]
+
+[tool.hatch.version]
+path = "src/lupaxa/sysinfo/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/**",
+  "README.md",
+  "README-PYPI.md",
+  "LICENCE",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lupaxa"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+# Core Lupaxa rule set
+select = [
+  # --- Essential correctness + hygiene ---
+  "E",    # pycodestyle: basic style errors
+  "F",    # pyflakes: unused vars, undefined names
+  "I",    # import sorting
+  "B",    # bugbear: common footguns
+
+  # --- Security layer ---
+  "S",    # bandit-like security checks
+
+  # --- Modernisation + cleanup ---
+  "UP",   # pyupgrade: modern Python idioms
+  "SIM",  # simplify complex expressions/conditions
+  "C4",   # flake8-comprehensions
+  "ISC",  # implicit string-concat safety
+
+  # --- New additions (strict mode) ---
+  "D",    # pydocstyle: docstring formatting/consistency
+  "ANN",  # annotations: missing/incorrect typing hints
+  "PT",   # pytest: best practices for tests
+]
+
+# Disable D2xx summary/spacing rules that conflict with our preferred style
+ignore = [
+  "D200", # one-line docstring violation (not needed for multi-line)
+  "D201", # no blank line before docstring
+  "D202", # blank line after docstring
+  "D203", # 1 blank line before class docstring
+  "D204", # 1 blank line after class docstring
+  "D205", # 1 blank line required between summary line and description
+  "D206", # various indentation rules
+  "D207",
+  "D208",
+  "D209",
+  "D210",
+  "D211",
+  "D212", # "Summary should start at first line" (we prefer second line)
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Nested test layout (tests/cli, tests/core); `tests/*` alone does not match.
+"tests/**/*.py" = [
+  "S101",   # allow bare assert in tests
+  "S105",   # allow test-only "password"-like literals
+  "ANN001", # allow untyped fixture arguments
+  "ANN201", # allow untyped test function returns
+]
+
+[tool.ruff.lint.pydocstyle]
+# NumPy-style docstrings, closest to our format
+convention = "numpy"
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+python_version = "3.10"
+files = ["src", "tests"]
+mypy_path = "src"
+explicit_package_bases = true
+namespace_packages = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = "-ra -q --disable-warnings"
+testpaths = ["tests"]
+pythonpath = ["src"]

lupaxa_sysinfo-0.1.0/src/lupaxa/sysinfo/__init__.py

@@ -0,0 +1,20 @@
+"""Lupaxa sysinfo — cross-platform system inventory library."""
+
+from __future__ import annotations
+
+from .api import collect_report
+from .collectors import SCHEMA_VERSION, set_strict_missing
+from .options import CollectOptions, RedactOptions
+from .redact import public_suffix_available
+from .version import __version__, get_version
+
+__all__ = [
+    "SCHEMA_VERSION",
+    "CollectOptions",
+    "RedactOptions",
+    "__version__",
+    "collect_report",
+    "get_version",
+    "public_suffix_available",
+    "set_strict_missing",
+]

lupaxa_sysinfo-0.1.0/src/lupaxa/sysinfo/__main__.py

@@ -0,0 +1,8 @@
+"""Allow ``python -m lupaxa.sysinfo`` to run the CLI."""
+
+from __future__ import annotations
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()