Metadata-Version: 2.4
Name: sensirion-driver-adapters
Version: 2.4.0
Summary: Adapter classes to use sensirion_i2c_driver package
Project-URL: Changelog, https://github.com/Sensirion/python-driver-adapters/blob/master/CHANGELOG.rst
Project-URL: Repository, https://github.com/Sensirion/python-driver-adapters
Project-URL: Documentation, https://sensirion.github.io/python-driver-adapters
Author-email: Sensirion <info@sensirion.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: driver,driver-generator,sensirion
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <4.0,>=3.8
Requires-Dist: sensirion-i2c-driver~=1.0.2
Requires-Dist: sensirion-shdlc-driver~=1.0.1
Requires-Dist: sensirion-shdlc-sensorbridge~=1.0.0
Provides-Extra: docs
Requires-Dist: docutils~=0.18.0; extra == 'docs'
Requires-Dist: lazy-object-proxy~=1.7.1; extra == 'docs'
Requires-Dist: sphinx-autoapi~=3.0.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme==3.0.2; extra == 'docs'
Requires-Dist: sphinx-rtd-theme~=1.3.0; extra == 'docs'
Requires-Dist: sphinx==8.2.3; extra == 'docs'
Provides-Extra: test
Requires-Dist: flake8>=7.1.0; extra == 'test'
Requires-Dist: mock~=5.2.0; extra == 'test'
Requires-Dist: pytest-cov>=5.0.0; extra == 'test'
Requires-Dist: pytest>=8.3.5; extra == 'test'
Requires-Dist: setuptools>=73.2.0; extra == 'test'
Description-Content-Type: text/markdown

# Sensirion Drvier Adapters

This repository contains adapter classes that can be used to separate the
logic of packaging user data into a byte stream and using that byte
stream in different channels.
The classes can be used as adapters to the *sensirion_i2c_driver.I2cConnection* and
*sensirion_shdlc_driver.ShdlcSerialPort*.

The python package sensirion-driver-adapters replaces the package sensirion-i2c-adapter. The latter is deprecated and
will no longer be maintained. All functionality of sensirion-i2c-adapter is contained within the package
sensirion-driver-adapters.

## Usage

See package description in [README.rst](https://github.com/Sensirion/python-driver-adapters/blob/master/README.rst) and user manual at
https://sensirion.github.io/python-driver-adapters/.

## 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`](http://flake8.pycqa.org/):

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

### Run tests

Unit tests can be run with [`pytest`](https://pytest.org/):

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

### Build documentation

The documentation can be built with [Sphinx](http://www.sphinx-doc.org/):

```bash
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](https://github.com/Sensirion/python-driver-adapters/blob/master/LICENSE).
