Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/build-and-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
on:
push:
branches:
- main
tags:
- "[0-9]+.[0-9]+.[0-9]+"

jobs:
build_and_deploy:
uses: sensirion/.github/.github/workflows/driver.python.pypi_publish.yml@main
secrets: inherit
12 changes: 12 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Publish Documentation
on:
workflow_dispatch:
push:
branches:
- main

jobs:
documentation:
uses: sensirion/.github/.github/workflows/driver.python.documentation.yml@main
with:
use-project-requirements: true
14 changes: 14 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Validate and Test Python Package
on:
pull_request:
branches:
- main
push:
branches:
- main

jobs:
test:
uses: sensirion/.github/.github/workflows/driver.python.test.yml@main
with:
hw-test-flag: needs_device
66 changes: 0 additions & 66 deletions .gitlab-ci.yml

This file was deleted.

23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# CHANGELOG

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.1.1] - 2022-02-15

### Fixed

- Fix encoding of ``long_description`` in ``setup.py`` on Windows, leading
to rendering issues on pypi.org

## [0.1.0] - 2022-02-15

### Added

- Initial release of the SEN5x driver

[Unreleased]: https://github.com/Sensirion/python-i2c-sen5x/compare/0.1.0...HEAD
[0.1.1]: https://github.com/Sensirion/python-i2c-sen5x/releases/tag/0.1.1
[0.1.0]: https://github.com/Sensirion/python-i2c-sen5x/releases/tag/0.1.0
11 changes: 0 additions & 11 deletions CHANGELOG.rst

This file was deleted.

1 change: 0 additions & 1 deletion MANIFEST.in

This file was deleted.

63 changes: 8 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,19 @@
# Python Driver for Sensirion SEN5x Sensors

This repository contains the Python driver to communicate with Sensirion
SEN5x sensors using the I²C interface. For details, please read the
package description in [README.rst](README.rst).
SEN5x sensors using the I²C interface. The SEN5x sensor family includes
the products SEN50, SEN54 and SEN55.

## Usage
## Documentation & Quickstart

See package description in [README.rst](README.rst) and user manual at
https://sensirion.github.io/python-i2c-sen5x/.
See the [documentation page](https://sensirion.github.io/python-i2c-sfm3505) for an API description and a
[quickstart](https://sensirion.github.io/python-i2c-sfm3505/quickstart.html) example.
The API description also highlights which features are supported by which product variant!

## 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 :)
## Contributing

### 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
```

In addition, we check the formatting of files with
[`editorconfig-checker`](https://editorconfig-checker.github.io/):

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

### Run tests

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

```bash
pip install -e .[test] # Install requirements
pytest -m "not needs_device" # Run tests without hardware
pytest # Run all tests
```

The tests with the marker `needs_device` have following requirements:

- A SEN55 or SEN54 device must be connected to a
[SensorBridge](https://sensirion.com/sensorbridge) on port 1.
- Pass the serial port where the SensorBridge is connected with
`--serial-port`, e.g. `pytest --serial-port=COM7`
- The SensorBridge must have default settings (baudrate 460800, address 0)

### 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
```
In case you want to contribute to this project, please read the [contribution guidelines]((https://sensirion.github.io/python-i2c-sfm3505/contributing.html)).

## License

Expand Down
15 changes: 0 additions & 15 deletions README.rst

This file was deleted.

16 changes: 0 additions & 16 deletions ci/set_git_config.sh

This file was deleted.

9 changes: 9 additions & 0 deletions docs/build-documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Build documentation
===================

The documentation is built with `Sphinx <http://www.sphinx-doc.org>`_:

.. code-block:: bash

python -m pip install .[docs] # Install doc requirements
sphinx-build -b html docs docs/_build/html # Build documentation
Loading
Loading