Version 3.0.3

What's Changed

Cleaned examples up by adding short explanations as docstrings, renaming file names for better readability, removing some unused imports and adding a simpler example for a two button set-up.

In order to avoid issues such as #37, created a pre-commit hook which synchronises the Usage Example section of README.rst with examples/button_handler_single_button.py.

• Created a pre-commit hook to update examples in README by @EGJ-Moorington in #42
• Cleaned examples up by @EGJ-Moorington in #44
• Release version 3.0.3 by @EGJ-Moorington in #45

Full Changelog: 3.0.2...3.0.3

Version 3.0.2

What's Changed

Updated the simple usage example in README.rst, which was outdated since the release of version 3.0.0, and added an advanced example for a single button setup. Thanks to @hartzell for his contributions!

• Updated example in README.rst by @EGJ-Moorington in #40
• Release version 3.0.2 by @EGJ-Moorington in #41

Full Changelog: 3.0.1...3.0.2

Version 3.0.1

What's Changed

Release version 3.0.1 by @EGJ-Moorington in #35

• Fixed Build CI workflow (#22)
  Fixes #17

• Fixed some typos in docstrings (#24)
  Resolves #23

• Fixed __version__ constant (#27)
  Resolves #25

• Updated .readthedocs.yaml with Sphinx configuration key (#28)
  Resolves #26

• Improved the documentation for contributing (#30)
  Closes #29

• Updated SPDX licencing tags for release 3.0.1 (#34)
  Closes #33

With this update, most of the git history was cleaned up. Because of this, some references to commits from issues and pull requests might have been lost. The git history tree has become considerably clearer, though.

Full Changelog: 3.0.0...3.0.1

Version 3.0.1 - Development testing version 1

This version is to test the PyPI and Read the Docs build workflow changes that are to be introduced in release version 3.0.1.

Full Changelog: 3.0.0...3.0.1.dev1

Version 3.0.0

What's Changed

Changed the action parameter of ButtonInput to take constants and integers as arguments instead of strings.

• Release version 3.0.0 by @EGJ-Moorington in #15

Full Changelog: 2.0.0...3.0.0

Version 2.0.0

What's Changed

Changed the library to work based on the CircuitPython keypad core module, improved documentation and added unit tests.

• Release version 2.0.0 by @EGJ-Moorington in #10

Full Changelog: 1.0.0...2.0.0

Version 2.0.0 - Beta 2

Second and last beta release of version 2.0.0.

What's Changed

• Added tests for the library, and fixed some found issues by @EGJ-Moorington in #7

Full Changelog: 2.0.0-beta.1...2.0.0-beta.2

Version 2.0.0 - Beta 1

First beta release of version 2.0.0.

What's Changed

• Implemented the keypad core module. by @EGJ-Moorington in #4
• Updated documentation to version 2.0.0 by @EGJ-Moorington in #5

Full Changelog: 1.0.0...2.0.0-beta.1

First release

First release including a variety of settings to use and four different inputs to detect.

Read the docs for info on how to use it.