https://github.com/pmav99/sysfacts
Gather facts about your PC
https://github.com/pmav99/sysfacts
facts system
Last synced: about 2 months ago
JSON representation
Gather facts about your PC
- Host: GitHub
- URL: https://github.com/pmav99/sysfacts
- Owner: pmav99
- License: mit
- Created: 2019-01-20T09:39:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-25T23:31:13.000Z (over 6 years ago)
- Last Synced: 2025-03-15T08:48:49.291Z (3 months ago)
- Topics: facts, system
- Language: Python
- Size: 29.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sysfacts
[](https://travis-ci.com/pmav99/sysfacts)
[](https://badge.fury.io/py/sysfacts)
`sysfacts` is a system information collector.
It can be used standalone or as a library. In order to achieve its goals, `sysfacts`
tries to leverage existing cross-platform python libraries.
## Installation
### `pipx`
The recommended installation method is [pipx](https://github.com/cs01/pipx). More
specifically, you can install `sysfacts` for your user with:
```
pipx install sysfacts
```
The above command will create a virtual environment in `~/.local/pipx/venvs/sysfacts`
and add the `sysfacts` script in `~/.local/bin`.
In case you need to run `sysfacts` just once, without installing it, you can do it with
``` shell
pipx run sysfacts
```
This way, `pipx` will create a temporary virtual environment, install `sysfacts`, run it
and cleanup afterwards.
### `pip`
Alternatively you can use good old `pip` but this is more fragile than `pipx`.
``` bash
pip install --user sysfacts
```
### As a dependency for another project
If you use [poetry](https://github.com/sdispater/poetry), you can use:
``` bash
poetry add sysfacts
```
## Usage
### CLI application
On the CLI application there are three options for the output format:
- colored, pretty-printed JSON (the default)
- machine readable JSON blob
- YAML
``` shell
sysfacts --help
# JSON output
sysfacts # colored + pretty-printed
sysfacts --no-color # pretty-printed
sysfacts --blob # machine readable
# YAML output
sysfacts --yaml
sysfacts --yaml --no-color
```
### API
The main function is `collect_facts()` which returns a python dictionary.
``` python
from sysfacts import collect_facts
facts = collect_facts()
```
## Alternative projects
Well, this is not really unique, since there are several similar projects out there
- puppet's [facter](https://github.com/puppetlabs/facter)
- chef's [ohai](https://github.com/chef/ohai) is written in ruby.
- datadog's [gohai]() is written in go.
- if you have ansible installed you can also use `ansible local -m setup`.