Metadata-Version: 2.1
Name: icsystemutils
Version: 0.0.3
Summary: Utilities for interacting with system resources, e.g. cpu, network etc.
Author-email: "James Grogan, Irish Centre for High End Computing" <james.grogan@ichec.ie>
Project-URL: Repository, https://git.ichec.ie/performance/toolshed/icsystemutils
Project-URL: Homepage, https://git.ichec.ie/performance/toolshed/icsystemutils
Keywords: System Utilities,HPC
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: iccore==0.0.8
Requires-Dist: psutil
Requires-Dist: fabric>=3.2.2
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: mypy; extra == "test"

`icsystemutils` is a Python package with some low-level utilities for interacting with real system resources (cpu, gpu, network etc).

It is maintained by the Irish Centre for High End Computing (ICHEC), mostly as a dependency of high-level packages and tools used to support ICHEC research and workflows.

# Examples #

Although this is mostly intended to be a library, some example uses to build CLI apps are shown below.

## Get CPU info ##

This reads the CPU info on Linux/Mac via system apis and returns the result as json.

``` shell
icsystemutils read_cpu
```

# License #

This project is Copyright of the Irish Centre for High End Computing. You can use it under the terms of the GPLv3+, which further details in the included LICENSE file.
