Metadata-Version: 2.4
Name: tomato-psutil
Version: 2.1.0
Summary: tomato driver interface to the psutil library
Author-email: Peter Kraus <peter.kraus@tu-berlin.de>
Maintainer-email: Peter Kraus <peter.kraus@tu-berlin.de>
Project-URL: Documentation, https://dgbowl.github.io/tomato-psutil/master
Project-URL: Issues, https://github.com/dgbowl/tomato-psutil/issues
Project-URL: Repository, https://github.com/dgbowl/tomato-psutil/
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil>=5.9
Requires-Dist: tomato>=2.1
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Provides-Extra: docs
Requires-Dist: sphinx~=7.2; extra == "docs"
Requires-Dist: sphinx-rtd-theme~=1.3.0; extra == "docs"
Requires-Dist: autodoc-pydantic~=1.9.0; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid~=0.9.2; extra == "docs"
Dynamic: license-file

# tomato-psutil
`tomato` driver for the [`psutil`](https://github.com/giampaolo/psutil) library.

This driver illustrates how a device driver can be implemented for devices which have no components. The driver is developed by the [ConCat lab at TU Berlin](https://tu.berlin/en/concat).

## Supported functions

### Capabilities
- `mem_info`: returns memory-related information
- `cpu_info`: returns CPU-related information
- `all_info`: returns all available information

### Attributes
- `mem_total`: the total physical memory installed, `RO`, `float`
- `mem_avail`: the available physical memory, `RO`, `float`
- `mem_usage`: the percentage of available physical memory, `RO`, `float`
- `cpu_count`: the number of logical CPUs, `RO`, `int`
- `cpu_freq`: the current frequency of the CPU (OS and CPU dependent), `RO`, `float`
- `cpu_usage`: the percentage of CPU usage, `RO`, `float`

## Contributors
- Peter Kraus
