:author: Marc 'BlackJack' Rintsch
-Python bindings for ``libsensors.so`` from the `lm-sensors` project via
+Python bindings for ``libsensors.so`` from the `lm-sensors`_ project via
+`ctypes`. Trying to support the last two libsensors APIs — versions 3 and 4.
-Trying to support the last two libsensors APIs — versions 3 and 4.
+Motivation for this package are shortcomings of scraping the output of
+the ``sensors`` command by different shell scripts. Some had problems when
+labels changed, others could not cope with too many matches of their
+overly broad regular expressions, and so on. Those scripts and thus
+this package are used at `RebeIT`_ for monitoring servers. The needs of
+that task are the driving force behind this implementation.
+* ``libsensors.so`` from `lm-sensors`_ version 2.x or 3.x
+The package is pure Python, so any implementation with the `ctypes` module
+should work. Tested so far with `CPython`_ and `PyPy`_.
+.. TODO: Lower requirements to Python 2.5 and test with Jython and IronPython.
+The usual ``python setup.py install`` from within the source distribution.
+PyPi Entry http://pypi.python.org/pypi/PySensors/
+Source repository https://bitbucket.org/blackjack/pysensors/
+The following example prints all detected sensor chips, their adapter, and the features with they ”main” value for each chip::
+ for chip in sensors.iter_detected_chips():
+ print '%s at %s' % (chip, chip.adapter_name)
+ print ' %s: %.2f' % (feature.label, feature.get_value())
+Example output of the code above::
+ k8temp-pci-00c3 at PCI adapter
+ w83627ehf-isa-0290 at ISA adapter
+.. _CPython: http://www.python.org/
+.. _lm-sensors: http://www.lm-sensors.org/
+.. _PyPy: http://pypy.org/
+.. _RebeIT: http://www.rebeit.de/