Skip to main content

Collect system information

Project description


Build Status

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.



The recommended installation method is 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

pipx run sysfacts

This way, pipx will create a temporary virtual environment, install sysfacts, run it and cleanup afterwards.


Alternatively you can use good old pip but this is more fragile than pipx.

pip install --user sysfacts

As a dependency for another project

If you use poetry, you can use:

poetry add sysfacts



On standalone mode the output format can be either JSON or YAML. You can also choose between a JSON data blob or colored, pretty-printed output.

sysfacts --help
# JSON output
sysfacts --pretty
sysfacts --pretty --no-color
# YAML output
sysfacts --yaml
sysfacts --yaml --no-color


The main function is collect_facts() which returns a python dictionary.

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
  • chef's 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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sysfacts, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size sysfacts-0.2.0.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View
Filename, size sysfacts-0.2.0-py3-none-any.whl (7.0 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page