{"author":null,"author_email":"Miguel Ángel García , Jan Wille ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Console","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: Microsoft :: Windows","Operating System :: POSIX :: Linux","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Topic :: Software Development","Topic :: Software Development :: User Interfaces"],"description":"[![GitHub Repository](https://img.shields.io/badge/-GitHub-%230D0D0D?logo=github&labelColor=gray)](https://github.com/magmax/python-readchar)\n[![Latest PyPi version](https://img.shields.io/pypi/v/readchar.svg)](https://pypi.python.org/pypi/readchar)\n[![supported Python versions](https://img.shields.io/pypi/pyversions/readchar)](https://pypi.python.org/pypi/readchar)\n[![Project licence](https://img.shields.io/pypi/l/readchar?color=blue)](LICENCE)
\n[![Automated testing results](https://img.shields.io/github/actions/workflow/status/magmax/python-readchar/run-tests.yaml?branch=master)](https://github.com/magmax/python-readchar/actions/workflows/run-tests.yaml?query=branch%3Amaster)\n[![Coveralls results](https://coveralls.io/repos/github/magmax/python-readchar/badge.svg?branch=master)](https://coveralls.io/github/magmax/python-readchar?branch=master)\n[![Number of PyPi downloads](https://img.shields.io/pypi/dd/readchar.svg)](https://pypi.python.org/pypi/readchar)\n\n# python-readchar\n\nLibrary to easily read single chars and keystrokes.\n\nBorn as a [python-inquirer](https://github.com/magmax/python-inquirer) requirement.\n\n## Installation\n\nsimply install it via `pip`:\n\n```bash\npip install readchar\n```\n\nOr download the source code from [PyPi](https://pypi.python.org/pypi/readchar).\n\n## Usage\n\nSimply read a character or keystroke:\n\n```python\nimport readchar\n\nkey = readchar.readkey()\n```\n\nReact to different kinds of key-presses:\n\n```python\nfrom readchar import readkey, key\n\nwhile True:\n k = readkey()\n if k == \"a\":\n # do stuff\n if k == key.DOWN:\n # do stuff\n if k == key.ENTER:\n break\n```\n\n## Documentation\n\nThere are just two methods:\n\n### `readchar.readchar() -> str`\n\nReads one character from `stdin`, returning it as a string with length 1. Waits until a\ncharacter is available.\n\nAs only ASCII characters are actually a single character, you usually want to use the\nnext function, that also handles longer keys.\n\n### `readchar.readkey() -> str`\n\nReads the next keystroke from `stdin`, returning it as a string. Waits until a keystroke\nis available.\n\nA keystroke can be:\n\n- single characters as returned by `readchar()`. These include:\n - character for normal keys: a, Z, 9,...\n - special characters like ENTER, BACKSPACE, TAB,...\n - combinations with CTRL: CTRL+A,...\n- keys that are made up of multiple characters:\n - characters for cursors/arrows: 🡩, 🡪, 🡫,\n 🡨\n - navigation keys: INSERT, HOME,...\n - function keys: F1 to F12\n - combinations with ALT: ALT+A,...\n - combinations with CTRL and ALT:\n CTRL+ALT+SUPR,...\n\n> **Note** CTRL+C will not be returned by `readkey()`, but instead\n> raise a `KeyboardInterupt`. If you want to handle it yourself, use `readchar()`.\n\n### `readchar.key` module\n\nThis submodule contains a list of available keys to compare against. The constants are\ndefined depending on your operating system, so it should be fully portable. If a key is\nlisted here for your platform, `readkey()` can read it, and you can compare against it.\n\n### `readchar.config` class\n\nThis static class contains configurations for `readchar`. It holds constants that are\nused in other parts of the code as class attributes. You can override/change these to\nmodify its behaviour. Here is a description of the existing attributes:\n\n

INTERRUPT_KEYS: \n\nList of keys that will result in `readkey()` raising a `KeyboardInterrupt`.
\n*Default:* `[key.CTRL_C]`\n\n

\n\n## OS Support\n\nThis library actively supports these operating systems:\n\n- Linux\n- Windows\n\nSome operating systems are enabled, but not actively tested or supported:\n\n- macOS\n- FreeBSD / OpenBSD\n\nTheoretically every Unix based system should work, but they will not be actively tested.\nIt is also required that somebody provides initial test results before the OS is enabled\nand added to the list. Feel free to open a PR for that.\n\nThank you!\n\n## How to contribute\n\nYou have an issue problem or found a bug? You have a great new idea or just want to fix\na typo? Great :+1:. We are happy to accept your issue or pull request, but first, please\nread our\n[contribution guidelines](https://github.com/magmax/python-readchar/blob/master/CONTRIBUTING.md).\nThey will also tell you how to write code for this repo and how to properly prepare an\nissue or a pull request.\n\n______________________________________________________________________\n\n*Copyright (c) 2014-2022 Miguel Ángel García*\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"characters, keystrokes, stdin, command line","license":"MIT Licence Copyright (c) 2022 Miguel Angel Garcia Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":"Jan Wille ","name":"readchar","package_url":"https://pypi.org/project/readchar/","platform":null,"project_url":"https://pypi.org/project/readchar/","project_urls":{"Changelog":"https://github.com/magmax/python-readchar/releases","Homepage":"https://pypi.org/project/readchar","Issues":"https://github.com/magmax/python-readchar/issues","Repository":"https://github.com/magmax/python-readchar"},"provides_extra":null,"release_url":"https://pypi.org/project/readchar/4.2.1/","requires_dist":null,"requires_python":">=3.8","summary":"Library to easily read single chars and key strokes","version":"4.2.1","yanked":false,"yanked_reason":null}

Package search

readchar

project_urls

Dependencies

All package metadata

Releases