Readchar

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:
bash

bash
pip install -U git+https://github.com/magmax/python-readcharv4.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: [](https://coveralls.io/github/Cube707/python-readchar?branch=master)

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