Metadata-Version: 2.4
Name: host-inspector
Version: 0.2.2
Summary: A simple python package to gather host information from Windows, Mac and Linux. Returns host data as dicts to be used internally or sent to front-end dashboard applications as JSON.
Author-email: Tim Santor <tsantor@xstudios.com>
Project-URL: Repository, https://github.com/tsantor/host-inspector.git
Project-URL: Issues, https://github.com/tsantor/host-inspector/issues
Project-URL: Changelog, https://github.com/tsantor/host-inspector/blob/master/HISTORY.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: humanize>=4.12.3
Requires-Dist: psutil>=7.0.0
Requires-Dist: py-machineid>=0.8.0
Dynamic: license-file

# Host Info

![Coverage](https://img.shields.io/badge/coverage-99%25-brightgreen)

## Overview

A simple python package to gather host information from Windows, Mac and Linux. Returns host data as dicts to be used internally or sent to front-end dashboard applications as JSON.

## Installation

Install Host Info:

```bash
python3 -m pip install host-inspector
```

## Development

To get a list of all commands with descriptions simply run `make`.

```bash
make env
make pip_install_editable
```

## Testing

```bash
make pytest
make coverage
make open_coverage
```

## Issues

If you experience any issues, please create an [issue](https://github.com/tsantor/host-inspector/issues) on Github.

## Example Usage

```python
from host_inspector import get_device_info
from host_inspector import get_health_info

print(get_device_info())
print(get_health_info())

# You can also call individual methods:
from host_inspector import get_cpu_info
from host_inspector import get_datetime_info
from host_inspector import get_disk_info
from host_inspector import get_gpu_info
from host_inspector import get_mem_info
from host_inspector import get_network_info
from host_inspector import get_os_info
from host_inspector import get_platform_info
from host_inspector import get_uptime_info
```

# History

All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).

## 0.1.0 (2025-08-06)

- First release

## 0.1.1 (2025-09-04)

- ADDED: Support for getting Windows Firewall status and rules

## 0.2.0 (2025-09-09)

- CHANGED: `get_device_info` now returns a `displays` key which is a list of connected displays
- CHANGED: `get_gpu_info` now returns a list of dicts (one for each GPU)
- ADDED: `get_display_info` returns a list of dicts (one for each display)
- CHANGED: For backawards compatability, when calling `get_device_info`, the `gpu` key will be an object if only one GPU detected.

## 0.2.1 (2025-09-23)

- ADDED: Support for getting Linux Firewall status and rules using `ufw`.

## 0.2.2 (2025-09-25)

- CHANGED: Standardize date/time formatting for device `uptime` and `local_datetime`
