Metadata-Version: 2.5
Name: lupaxa-sysinfo
Version: 0.1.1
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) 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>
