What's Changed

• Implement Unicode support @sakkyoi in #119

New Contributors

• @sakkyoi made their first contribution in #119

Full Changelog: v4.1.0...v4.2.0

What's Changed

• migrate from setup.cfg to pyproject.toml by @Cube707 in #118

Full Changelog: v4.0.6...v4.1.0

this is a preview version for testing. It introduces a new Context-Manager (named ReadChar). See #96 for details

You can install this version via on of the commands:

pip install -U --pre readchar==4.1.0.dev1

pip install -U git+https://github.com/magmax/python-readchar@v4.1.0-dev1

changed

• removed code-duplication from key.py (#113)

fixed

• typos (#104, #105)

added

• Python 3.12 to classifiers and tests (#114)

removed

• dropped Python 3.7, as its EOL (0277fed)

added

• enabled OpenBSD OS (see #103)

fixed

• spelling and false links
• pre-commit broken pipeline (updated pre-commit packages)
• broken shield.io badge in README

removed

• Python 3.6 from tests and classifiers

added

• Python 3.11 to classifiers and tests
• py.typed file to support mypy type-stubs

this is a preview version for testing. It should enable mypy to analyse readchar. See #100 for details It should now actually contain the changes and incorperates the updated deploy workflow that allows for releases from development branches

You can install this version via on of the commands:

pip install -U --pre readchar==4.0.4.dev2

pip install -U git+https://github.com/magmax/python-readchar@v4.0.4-dev2

removed

• wheel is no longer a install-requirement, only a build requiremnt (if user wants wheel support, he can install it, but we shouldn't force it)
• tests_require from setup.cfg, it's not used anyway

changed

• small README formating fixups
• simplifyed dev-install. requirements.txt now containes the editable-self-install. one less setp is reuqired for setup.

added

• mdformat as pre-commit hook

added

• config class. This static class hold constants that can be changed by the user to change the libarys behavior. Use the class-attributes directly, you don't need to create instances of it! currently it only holds INTERRUPT_KEYS, a list of keys that will result in an KeyboardInterrupt beeing raised
• .editorconfig

changed

• documentation is now in Markdown instead of rst

added

• key.DELETE as an alias for key.SUPR

Breaking changes

• the readkey() function now raises a KeyboardInterupt when CTRL+C is pressed. (but readchar() can still be used to capture it). This is more inline with the python philosophy (IMHO) and prevents developers from accidentally trapping their users with no option to stop the programm.
• the ESCAPE_SEQUENCES variable, it's no longer used

fixes

• windows now returns strings instead of bytestrings, same as on linux
• windows now supports most special characters
• swaped LF and CR, as per #69
• windows actually returns CR on ENTER, so the ENTER variable now points to the appropriate existing variable
• __all__ should return a list of strings
• f5-f12 had wrong codes on linux
• code coverage is much better now:

added

• extensive testing for both windows and linux
• automated workflow that runs the test on both platforms
• more keycodes for windows
• add end-of-line-fixer to pre-commit
• add LICENCE (#44)
• mac OS and FreeBSD run the linux behavior (note in the README that they are not supported but should work)
• SHIFT+TAB support on Linux

removed

• removed python 2.7, 3.4, 3.5 and pypy support

changed

• general cleanup of config and setup files
• bump precommit-hook versions
• simplyfied .yamellinter.yml
• reworked the github actions

I fixed the import issue (#88)

this is a preview version of the new v4.0.0 developments for testing. Please feel free to tell us about any issues you encounter with it.

You can use one of this command to install it:

pip install -U --pre readchar==4.0.0.dev0

pip install -U git+https://github.com/magmax/python-readchar@v4.0.0-dev0

• corrected metadata
• bump yamllint

• reverts bad PR #65, which broke BACKSPACE for Linux systems and didn't really fix arrow support on windows
• actually enabel arrow/special Key support for windows
• fix BACKSPACE and ENTER for windows

~Fix Windows problem with backspace and arrows codes.~

Attention: this has been reverted!

rollback to use setraw instead of setcbreak.

Fixes:

• #53, using setcbreak instead of setraw.
• Add more key codes as constants.

This is just a version with minor changes and, mainly, latest merges.

The numeration change is just because the 1.0 was a fail and I wanted to show a change of mind in releases: I will take care of them more seriously from now on.