| Name | jk_terminal_essentials JSON |
| Version |
0.2024.2.2
JSON |
| download |
| home_page | None |
| Summary | This module provides essential constants and information about the terminal. This module is intended for implementing CLI tools and other applications running in a terminal. |
| upload_time | 2024-02-02 11:46:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
console
terminal
colors
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
jk_terminal_essentials
==========
Introduction
------------
This module provides essential constants and information about the terminal. This module is intended for implementing CLI tools and other applications running in a terminal.
Information about this module can be found here:
* [github.org](https://github.com/jkpubsrc/....)
* [pypi.python.org](https://pypi.python.org/pypi/jk_terminal_essentials)
How to use this module
----------------------
### Import this module
Please include this module into your application using the following code:
```python
import jk_terminal_essentials as te
```
### Colors
This module provides a variety of color constants. For example:
```python
print(te.FGCOLOR_RED + "Error!" + te.STYLE_RESET)
```
The following colors are supported:
```python
FGCOLOR_BLACK = "\x1b[30m"
FGCOLOR_RED = "\x1b[31m"
FGCOLOR_GREEN = "\x1b[32m"
FGCOLOR_YELLOW = "\x1b[33m"
FGCOLOR_BLUE = "\x1b[34m"
FGCOLOR_MAGENTA = "\x1b[35m"
FGCOLOR_CYAN = "\x1b[36m"
FGCOLOR_LIGHT_GRAY = "\x1b[37m"
FGCOLOR_DARK_GRAY = "\x1b[90m"
FGCOLOR_LIGHT_RED = "\x1b[91m"
FGCOLOR_LIGHT_GREEN = "\x1b[92m"
FGCOLOR_LIGHT_YELLOW = "\x1b[93m"
FGCOLOR_LIGHT_BLUE = "\x1b[94m"
FGCOLOR_LIGHT_MAGENTA = "\x1b[95m"
FGCOLOR_LIGHT_CYAN = "\x1b[96m"
FGCOLOR_WHITE = "\x1b[97m"
BGCOLOR_BLACK = "\x1b[40m"
BGCOLOR_RED = "\x1b[41m"
BGCOLOR_GREEN = "\x1b[42m"
BGCOLOR_YELLOW = "\x1b[43m"
BGCOLOR_BLUE = "\x1b[44m"
BGCOLOR_MAGENTA = "\x1b[45m"
BGCOLOR_CYAN = "\x1b[46m"
BGCOLOR_LIGHT_GRAY = "\x1b[47m"
BGCOLOR_DARK_GRAY = "\x1b[100m"
BGCOLOR_LIGHT_RED = "\x1b[101m"
BGCOLOR_LIGHT_GREEN = "\x1b[102m"
BGCOLOR_LIGHT_YELLOW = "\x1b[103m"
BGCOLOR_LIGHT_BLUE = "\x1b[104m"
BGCOLOR_LIGHT_MAGENTA = "\x1b[105m"
BGCOLOR_LIGHT_CYAN = "\x1b[106m"
BGCOLOR_WHITE = "\x1b[107m"
```
### Check for Color Support
To check if the current terminal supports colors:
```python
print(te.checkTerminalSupportsColors())
```
Author(s)
-------------------
* Jürgen Knauth: pubsrc@binary-overflow.de
License
-------
This software is provided under the following license:
* Apache Software License 2.0
Raw data
{
"_id": null,
"home_page": null,
"name": "jk_terminal_essentials",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "J\u00fcrgen Knauth <pubsrc@binary-overflow.de>",
"keywords": "console,terminal,colors",
"author": null,
"author_email": "J\u00fcrgen Knauth <pubsrc@binary-overflow.de>",
"download_url": "https://files.pythonhosted.org/packages/91/a0/e4693a40aa8b3d1f9747454251a61fea90e5c1f2290d67b2c192611eeeaf/jk_terminal_essentials-0.2024.2.2.tar.gz",
"platform": null,
"description": "jk_terminal_essentials\n==========\n\nIntroduction\n------------\n\nThis module provides essential constants and information about the terminal. This module is intended for implementing CLI tools and other applications running in a terminal.\n\nInformation about this module can be found here:\n\n* [github.org](https://github.com/jkpubsrc/....)\n* [pypi.python.org](https://pypi.python.org/pypi/jk_terminal_essentials)\n\nHow to use this module\n----------------------\n\n### Import this module\n\nPlease include this module into your application using the following code:\n\n```python\nimport jk_terminal_essentials as te\n```\n\n### Colors\n\nThis module provides a variety of color constants. For example:\n\n```python\nprint(te.FGCOLOR_RED + \"Error!\" + te.STYLE_RESET)\n```\n\nThe following colors are supported:\n\n```python\nFGCOLOR_BLACK = \"\\x1b[30m\"\nFGCOLOR_RED = \"\\x1b[31m\"\nFGCOLOR_GREEN = \"\\x1b[32m\"\nFGCOLOR_YELLOW = \"\\x1b[33m\"\nFGCOLOR_BLUE = \"\\x1b[34m\"\nFGCOLOR_MAGENTA = \"\\x1b[35m\"\nFGCOLOR_CYAN = \"\\x1b[36m\"\nFGCOLOR_LIGHT_GRAY = \"\\x1b[37m\"\n\nFGCOLOR_DARK_GRAY = \"\\x1b[90m\"\nFGCOLOR_LIGHT_RED = \"\\x1b[91m\"\nFGCOLOR_LIGHT_GREEN = \"\\x1b[92m\"\nFGCOLOR_LIGHT_YELLOW = \"\\x1b[93m\"\nFGCOLOR_LIGHT_BLUE = \"\\x1b[94m\"\nFGCOLOR_LIGHT_MAGENTA = \"\\x1b[95m\"\nFGCOLOR_LIGHT_CYAN = \"\\x1b[96m\"\nFGCOLOR_WHITE = \"\\x1b[97m\"\n\nBGCOLOR_BLACK = \"\\x1b[40m\"\nBGCOLOR_RED = \"\\x1b[41m\"\nBGCOLOR_GREEN = \"\\x1b[42m\"\nBGCOLOR_YELLOW = \"\\x1b[43m\"\nBGCOLOR_BLUE = \"\\x1b[44m\"\nBGCOLOR_MAGENTA = \"\\x1b[45m\"\nBGCOLOR_CYAN = \"\\x1b[46m\"\nBGCOLOR_LIGHT_GRAY = \"\\x1b[47m\"\n\nBGCOLOR_DARK_GRAY = \"\\x1b[100m\"\nBGCOLOR_LIGHT_RED = \"\\x1b[101m\"\nBGCOLOR_LIGHT_GREEN = \"\\x1b[102m\"\nBGCOLOR_LIGHT_YELLOW = \"\\x1b[103m\"\nBGCOLOR_LIGHT_BLUE = \"\\x1b[104m\"\nBGCOLOR_LIGHT_MAGENTA = \"\\x1b[105m\"\nBGCOLOR_LIGHT_CYAN = \"\\x1b[106m\"\nBGCOLOR_WHITE = \"\\x1b[107m\"\n```\n\n### Check for Color Support\n\nTo check if the current terminal supports colors:\n\n```python\nprint(te.checkTerminalSupportsColors())\n```\n\nAuthor(s)\n-------------------\n\n* J\u00fcrgen Knauth: pubsrc@binary-overflow.de\n\nLicense\n-------\n\nThis software is provided under the following license:\n\n* Apache Software License 2.0\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "This module provides essential constants and information about the terminal. This module is intended for implementing CLI tools and other applications running in a terminal.",
"version": "0.2024.2.2",
"project_urls": null,
"split_keywords": [
"console",
"terminal",
"colors"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "122b30cc0a3f8d8f6a238e628ff6d0cd0725eed516dd7e48b4fb79fe14b201de",
"md5": "305d7e5d8f4b0d26e35b24c4ebaa1aac",
"sha256": "c4e445fb67377ceb944730c308d715975809b870fde99919676ca926a3748ddf"
},
"downloads": -1,
"filename": "jk_terminal_essentials-0.2024.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "305d7e5d8f4b0d26e35b24c4ebaa1aac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5584,
"upload_time": "2024-02-02T11:46:32",
"upload_time_iso_8601": "2024-02-02T11:46:32.937837Z",
"url": "https://files.pythonhosted.org/packages/12/2b/30cc0a3f8d8f6a238e628ff6d0cd0725eed516dd7e48b4fb79fe14b201de/jk_terminal_essentials-0.2024.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "91a0e4693a40aa8b3d1f9747454251a61fea90e5c1f2290d67b2c192611eeeaf",
"md5": "77c56a24ef23fc4c29a3c1139259dd73",
"sha256": "f6de7baf3172425efdc7ec02647601ce2692565a1cb0845abd3d6734134ac93e"
},
"downloads": -1,
"filename": "jk_terminal_essentials-0.2024.2.2.tar.gz",
"has_sig": false,
"md5_digest": "77c56a24ef23fc4c29a3c1139259dd73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4187,
"upload_time": "2024-02-02T11:46:34",
"upload_time_iso_8601": "2024-02-02T11:46:34.771064Z",
"url": "https://files.pythonhosted.org/packages/91/a0/e4693a40aa8b3d1f9747454251a61fea90e5c1f2290d67b2c192611eeeaf/jk_terminal_essentials-0.2024.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 11:46:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jk_terminal_essentials"
}
