Participation by NIST in the creation of the documentation of mentioned software is not intended to imply a recommendation or endorsement by the National Institute of Standards and Technology, nor is it intended to imply that any specific software is necessarily the best available for the purpose.
To install this software, clone this repository, and run pip install .
from within this directory. (You might want to do this in a virtual environment.)
This provides a standalone command:
case_macos_system_profiler output.json
If provided no arguments, the default behavior is to invoke system_profiler
and render its observations about the current operating system environment.
For testing purposes, runtime modes are available to review specific data types from recorded system_profiler
output. E.g. this pipeline, exercised under tests/cli
, reviews the SPHardwareDataType
output:
system_profiler \
-detailLevel full \
-json \
SPHardwareDataType \
> tmp.json
case_macos_system_profiler \
--SPHardwareDataType-json tmp.json \
output.json
Tests are run on sanitized sample JSON files.
This project follows SEMVER 2.0.0 where versions are declared.
Some make
targets are defined for this repository:
all
- Installspre-commit
for this cloned repository instance.check
- Run unit tests. NOTE: The tests entail an installation of this project's source tree, including prerequisites downloaded from PyPI.clean
- Remove test build files.
This repository is licensed under the Apache 2.0 License. See LICENSE.
Portions of this repository contributed by NIST are governed by the NIST Software Licensing Statement.