keypress

Name	keypress JSON
Version	0.1.7 JSON
	download
home_page	None
Summary	Cross-Platform Key Handling Module: Effortlessly Detect and Describe Keyboard Events
upload_time	2024-08-29 06:40:26
maintainer	None
docs_url	None
author	hyperoot
requires_python	<4.0,>=3.12
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <h1 align="center">keypress</h1>

<p align="center">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/HYP3R00T/keypress/publish.yml?style=for-the-badge&labelColor=%2324273a&color=%23b7bdf8">
<a src="https://pypi.org/project/keypress/" target="_blank">
<img alt="Pypi versions" src="https://img.shields.io/pypi/v/keypress?style=for-the-badge&labelColor=%2324273a&color=%23b7bdf8">
</a>
</p>

This module offers a comprehensive solution for handling keyboard input across platforms. Whether you’re detecting simple keypresses or complex key combinations, our `get_key` function and `Keys` constants deliver robust functionality with clear, descriptive outputs. Perfect for developers needing to implement precise keyboard interactions in their applications.

## Installation

You can install **keypress** via [pip](https://pypi.org/project/keypress/):

```bash
pip install keypress
```

## Example

You can run **keypress** in your terminal.

```python
from keypress import Keys, get_key

if __name__ == "__main__":
    key = ""
    while key not in ["q", Keys.ENTER]:
        key = get_key()
        if key.is_printable:
            print(key)
        print(key.key_codes)
        print(key.description)
```

## Contributing

Contributions are welcome! Please see our [contributing guidelines](CONTRIBUTING.md) for more information.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "keypress",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "hyperoot",
    "author_email": "rajesh@hyperoot.dev",
    "download_url": "https://files.pythonhosted.org/packages/77/2a/120ee27e559b78904ce0f932fcf61e696453dc71038076ede03fc065b972/keypress-0.1.7.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">keypress</h1>\n\n<p align=\"center\">\n<img alt=\"GitHub Actions Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/HYP3R00T/keypress/publish.yml?style=for-the-badge&labelColor=%2324273a&color=%23b7bdf8\">\n<a src=\"https://pypi.org/project/keypress/\" target=\"_blank\">\n<img alt=\"Pypi versions\" src=\"https://img.shields.io/pypi/v/keypress?style=for-the-badge&labelColor=%2324273a&color=%23b7bdf8\">\n</a>\n</p>\n\nThis module offers a comprehensive solution for handling keyboard input across platforms. Whether you\u2019re detecting simple keypresses or complex key combinations, our `get_key` function and `Keys` constants deliver robust functionality with clear, descriptive outputs. Perfect for developers needing to implement precise keyboard interactions in their applications.\n\n## Installation\n\nYou can install **keypress** via [pip](https://pypi.org/project/keypress/):\n\n```bash\npip install keypress\n```\n\n## Example\n\nYou can run **keypress** in your terminal.\n\n```python\nfrom keypress import Keys, get_key\n\nif __name__ == \"__main__\":\n    key = \"\"\n    while key not in [\"q\", Keys.ENTER]:\n        key = get_key()\n        if key.is_printable:\n            print(key)\n        print(key.key_codes)\n        print(key.description)\n```\n\n## Contributing\n\nContributions are welcome! Please see our [contributing guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Cross-Platform Key Handling Module: Effortlessly Detect and Describe Keyboard Events",
    "version": "0.1.7",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "13efa43520f90f6488f9687058254e96c39505e0fadc01f834742b6ab48b3e18",
                "md5": "aa344a238b9055f484253cc80fbd9994",
                "sha256": "5f2b7e1b1911379e29884196b62bc0d2f95993dd0245750f10043e34736c6a1d"
            },
            "downloads": -1,
            "filename": "keypress-0.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aa344a238b9055f484253cc80fbd9994",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 5446,
            "upload_time": "2024-08-29T06:40:25",
            "upload_time_iso_8601": "2024-08-29T06:40:25.608092Z",
            "url": "https://files.pythonhosted.org/packages/13/ef/a43520f90f6488f9687058254e96c39505e0fadc01f834742b6ab48b3e18/keypress-0.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "772a120ee27e559b78904ce0f932fcf61e696453dc71038076ede03fc065b972",
                "md5": "d70636c688ee953743975eda180b52f9",
                "sha256": "746b1285ef2fbfe1d084be66b511683f14a8857137c215709e5abbab59bb0c36"
            },
            "downloads": -1,
            "filename": "keypress-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "d70636c688ee953743975eda180b52f9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 5051,
            "upload_time": "2024-08-29T06:40:26",
            "upload_time_iso_8601": "2024-08-29T06:40:26.414248Z",
            "url": "https://files.pythonhosted.org/packages/77/2a/120ee27e559b78904ce0f932fcf61e696453dc71038076ede03fc065b972/keypress-0.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-29 06:40:26",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "keypress"
}