Python Driver for I2C Devices

This repository contains the common I2C driver used by various Sensirion sensor drivers. For details, please read the package description in README.rst.

Attribution ** FORK **

This library is a fork of the official python library from Sensirion, to add support for CircuitPython on embedded devices and linux SBCs.

Usage

See package description in README.rst and user manual at https://sensirion.github.io/python-i2c-driver/.

Development

We develop and test this driver using our company internal tools (version control, continuous integration, code review etc.) and automatically synchronize the master branch with GitHub. But this doesn't mean that we don't respond to issues or don't accept pull requests on GitHub. In fact, you're very welcome to open issues or create pull requests :)

Check coding style

The coding style can be checked with flake8:

pip install -e .[test]  # Install requirements
flake8                  # Run style check

In addition, we check the formatting of files with editorconfig-checker:

pip install editorconfig-checker==2.0.3   # Install requirements
editorconfig-checker                      # Run check

Run tests

Unit tests can be run with pytest:

pip install -e .[test]          # Install requirements
pytest                          # Run tests

Build documentation

The documentation can be built with Sphinx:

python setup.py install                        # Install package
pip install -r docs/requirements.txt           # Install requirements
sphinx-versioning build docs docs/_build/html  # Build documentation

License

See LICENSE.