| Name | kolorjet JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | Print colored text in python and perform color conversions |
| upload_time | 2023-12-21 06:44:25 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
ansi
color
text
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Installation
Use [pip](https://pip.pypa.io/en/stable/) to install kolorjet:
```bash
pip install kolorjet
```
## How To Print Colored Text
We can print text with a colored foreground:
```python
from kolorjet import fg
# Normal Colors
print(fg.red + "Red Text")
print(fg.green + "Green Text")
print(fg.blue + "Blue Text")
# Light Colors
print(fg.lightred + "Light Red Text")
print(fg.lightgreen + "Light Green Text")
print(fg.lightBlue + "Light Blue Text")
```
How it appears:
We can also print text with a colored background:
```python
from kolorjet import bg
# Normal Colors
print(bg.red + "Red Background")
print(bg.green + "Green Background")
print(bg.blue + "Blue Background")
# Light Colors
print(bg.lightred + "Light Red Background")
print(bg.lightgreen + "Light Green Background")
print(bg.lightblue + "Light Blue Background")
```
How it appears:
Available colors for fg and bg:
| Color | Name |
|:---------------------------------------------------------------:|----------------|
|  | black |
|  | red |
|  | green |
|  | yellow |
|  | blue |
|  | magenta |
|  | cyan |
|  | grey |
|  | darkgrey |
|  | lightred |
|  | lightgreen |
|  | lightyellow |
|  | lightblue |
|  | lightmagenta |
|  | lightcyan |
|  | white |
## How To Print Text Using Customized Colors
We can print using customized colors with Color Spaces RGB, HSL, HSV, Hex, CMYK:
```python
from kolorjet import fg, bg, reset
# Foreground Colors
print(fg.rgb(255, 0, 0) + "Red Text")
print(fg.hsl(30, 100, 50) + "Orange Text")
print(fg.hsv(60, 100, 100) + "Yellow Text")
print(fg.hex('#00FF00') + "Green Text")
print(fg.cmyk(100, 0, 0, 0) + "Cyan Text" + reset.fg)
# Background Colors
print(bg.rgb(255, 0, 0) + "Red Background")
print(bg.hsl(30, 100, 50) + "Orange Background")
print(bg.hsl(60, 100, 100) + "Yellow Background")
print(bg.hex('#00FF00') + "Green Background")
print(bg.cmyk(100, 0, 0, 0) + "Cyan Background" + reset.bg)
```
How it appears:
## How To Print Stylized Text
We can also print Stylized Text:
```python
from kolorjet import style
# Styles
print(style.bold + "Bold Text" + style.reset.bold)
print(style.underline + "Underlined Text" + style.reset.underline)
```
How it appears:
Available Styles:
1. bold
2. dim
3. italic
4. underline
5. blink
6. rapidblink
7. reverse
8. invisible
9. strikethrough
Note: Some styles may not be supported in all terminals, and may have a different function.
## How To Use The Helper
### How To Check Color Model Values:
We can check whether HSL, HSV, Hex, CMYK and RGB Values are correct:
If the given color space values are correct, It will return True or else False.
```python
from kolorjet.helper import check
# Valid Values
print(check.rgb(255,128,0))
print(check.hsl(30, 100, 50))
print(check.hsv(30, 100, 100))
print(check.hex('#FF8000'))
print(check.cmyk(0, 50, 100, 0))
# Invalid Values
print(check.rgb(300,128,0))
print(check.hsl(400, 100, 50))
print(check.hsv(400, 100, 100))
print(check.hex('#ZZ8000'))
print(check.cmyk(0, 50, 200, 0))
```
The first five lines will return True as the given values are correct but the next five will return False as the given values are incorrect.
### Valid Color Model Ranges:
RGB = R - (0, 255), G - (0, 255), B - (0, 255)
HSL = H - (0.0, 360.0), S - (0.0, 100.0), L - (0.0, 100.0)
HSV = H - (0.0, 360.0), S - (0.0, 100.0), V - (0.0, 100.0)
Hex = Numbers 0 to 9 and Letters A to F with Length of 6 Characters
CMYK = C - (0, 100), M - (0, 100), Y - (0, 100), K - (0, 100)
### How To Convert Values Between Color Models:
We can convert HSL, HSV, Hex, CMYK to RGB and back:
```python
from kolorjet.helper import convert
# Color Models To RGB
print(convert.hsl_to_rgb(30, 100, 50))
print(convert.hsv_to_rgb(30, 100, 100))
print(convert.hex_to_rgb('#FF8000'))
print(convert.cmyk_to_rgb(0, 50, 100, 0))
# RGB To Color Models
print(convert.rgb_to_hsl(255, 0, 0))
print(convert.rgb_to_hsv(255, 128, 0))
print(convert.rgb_to_hex(255, 255, 0))
print(convert.rgb_to_cmyk(0, 255, 0))
```
Output:
## Thanks!
### Contribute
If you have any suggestions, create a pull request [here](https://github.com/Samuel9360639/kolorjet/pulls).
### Report Bugs
If you find any bugs, please report them [here](https://github.com/Samuel9360639/kolorjet/issues).
Raw data
{
"_id": null,
"home_page": "",
"name": "kolorjet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "ANSI,Color,Text",
"author": "",
"author_email": "Samuel <samuel.9360639@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/f3/2807bf296305fa23bb8e3927a57c3c7a03b1bfd0625593b6be41cb492138/kolorjet-0.0.1.tar.gz",
"platform": null,
"description": "## Installation\n\nUse [pip](https://pip.pypa.io/en/stable/) to install kolorjet:\n\n```bash\npip install kolorjet\n```\n\n## How To Print Colored Text\n\nWe can print text with a colored foreground:\n\n```python\nfrom kolorjet import fg\n\n# Normal Colors\nprint(fg.red + \"Red Text\")\nprint(fg.green + \"Green Text\")\nprint(fg.blue + \"Blue Text\")\n\n# Light Colors\nprint(fg.lightred + \"Light Red Text\")\nprint(fg.lightgreen + \"Light Green Text\")\nprint(fg.lightBlue + \"Light Blue Text\")\n```\n\nHow it appears:\n\n\n\nWe can also print text with a colored background:\n\n```python\nfrom kolorjet import bg\n\n# Normal Colors\nprint(bg.red + \"Red Background\")\nprint(bg.green + \"Green Background\")\nprint(bg.blue + \"Blue Background\")\n\n# Light Colors\nprint(bg.lightred + \"Light Red Background\")\nprint(bg.lightgreen + \"Light Green Background\")\nprint(bg.lightblue + \"Light Blue Background\")\n```\n\nHow it appears:\n\n\n\nAvailable colors for fg and bg:\n\n| Color | Name |\n|:---------------------------------------------------------------:|----------------|\n|  | black |\n|  | red |\n|  | green |\n|  | yellow |\n|  | blue |\n|  | magenta |\n|  | cyan |\n|  | grey |\n|  | darkgrey |\n|  | lightred |\n|  | lightgreen |\n|  | lightyellow |\n|  | lightblue |\n|  | lightmagenta |\n|  | lightcyan |\n|  | white |\n\n## How To Print Text Using Customized Colors\n\nWe can print using customized colors with Color Spaces RGB, HSL, HSV, Hex, CMYK:\n\n```python\nfrom kolorjet import fg, bg, reset\n\n# Foreground Colors\nprint(fg.rgb(255, 0, 0) + \"Red Text\")\nprint(fg.hsl(30, 100, 50) + \"Orange Text\")\nprint(fg.hsv(60, 100, 100) + \"Yellow Text\")\nprint(fg.hex('#00FF00') + \"Green Text\")\nprint(fg.cmyk(100, 0, 0, 0) + \"Cyan Text\" + reset.fg)\n\n# Background Colors\nprint(bg.rgb(255, 0, 0) + \"Red Background\")\nprint(bg.hsl(30, 100, 50) + \"Orange Background\")\nprint(bg.hsl(60, 100, 100) + \"Yellow Background\")\nprint(bg.hex('#00FF00') + \"Green Background\")\nprint(bg.cmyk(100, 0, 0, 0) + \"Cyan Background\" + reset.bg)\n```\n\nHow it appears:\n\n\n\n## How To Print Stylized Text\n\nWe can also print Stylized Text:\n\n```python\nfrom kolorjet import style\n\n# Styles\nprint(style.bold + \"Bold Text\" + style.reset.bold)\nprint(style.underline + \"Underlined Text\" + style.reset.underline)\n```\n\nHow it appears:\n\n\n\nAvailable Styles:\n \n 1. bold\n 2. dim\n 3. italic\n 4. underline\n 5. blink\n 6. rapidblink\n 7. reverse\n 8. invisible\n 9. strikethrough\n\nNote: Some styles may not be supported in all terminals, and may have a different function.\n\n## How To Use The Helper\n\n### How To Check Color Model Values:\n\nWe can check whether HSL, HSV, Hex, CMYK and RGB Values are correct:\n\nIf the given color space values are correct, It will return True or else False.\n\n```python\nfrom kolorjet.helper import check\n\n# Valid Values\nprint(check.rgb(255,128,0))\nprint(check.hsl(30, 100, 50))\nprint(check.hsv(30, 100, 100))\nprint(check.hex('#FF8000'))\nprint(check.cmyk(0, 50, 100, 0))\n\n# Invalid Values\nprint(check.rgb(300,128,0))\nprint(check.hsl(400, 100, 50))\nprint(check.hsv(400, 100, 100))\nprint(check.hex('#ZZ8000'))\nprint(check.cmyk(0, 50, 200, 0))\n```\n\nThe first five lines will return True as the given values are correct but the next five will return False as the given values are incorrect.\n\n### Valid Color Model Ranges:\n\n RGB = R - (0, 255), G - (0, 255), B - (0, 255)\n HSL = H - (0.0, 360.0), S - (0.0, 100.0), L - (0.0, 100.0)\n HSV = H - (0.0, 360.0), S - (0.0, 100.0), V - (0.0, 100.0)\n Hex = Numbers 0 to 9 and Letters A to F with Length of 6 Characters\n CMYK = C - (0, 100), M - (0, 100), Y - (0, 100), K - (0, 100)\n\n### How To Convert Values Between Color Models:\n\nWe can convert HSL, HSV, Hex, CMYK to RGB and back:\n\n```python\nfrom kolorjet.helper import convert\n\n# Color Models To RGB\nprint(convert.hsl_to_rgb(30, 100, 50))\nprint(convert.hsv_to_rgb(30, 100, 100))\nprint(convert.hex_to_rgb('#FF8000'))\nprint(convert.cmyk_to_rgb(0, 50, 100, 0))\n\n# RGB To Color Models\nprint(convert.rgb_to_hsl(255, 0, 0))\nprint(convert.rgb_to_hsv(255, 128, 0))\nprint(convert.rgb_to_hex(255, 255, 0))\nprint(convert.rgb_to_cmyk(0, 255, 0))\n```\n\nOutput:\n\n\n\n## Thanks!\n\n### Contribute\n\nIf you have any suggestions, create a pull request [here](https://github.com/Samuel9360639/kolorjet/pulls).\n\n### Report Bugs\n\nIf you find any bugs, please report them [here](https://github.com/Samuel9360639/kolorjet/issues).",
"bugtrack_url": null,
"license": "MIT",
"summary": "Print colored text in python and perform color conversions",
"version": "0.0.1",
"project_urls": {
"Contribute": "https://github.com/Samuel9360639/kolorjet/pulls",
"Homepage": "https://github.com/Samuel9360639/kolorjet",
"Issues": "https://github.com/Samuel9360639/kolorjet/issues"
},
"split_keywords": [
"ansi",
"color",
"text"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "118e70be9a017256da753a7f5d3394fcc0df3b182e2f18197c505b26a5cbf57d",
"md5": "d9ff9c2a0d0ca5f21ef3f995f062d2c4",
"sha256": "10c6b56873e852a8ceedd125ad7e2d7cffb428e723b2bba8a8c69a0489e9a22d"
},
"downloads": -1,
"filename": "kolorjet-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d9ff9c2a0d0ca5f21ef3f995f062d2c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9309,
"upload_time": "2023-12-21T06:44:23",
"upload_time_iso_8601": "2023-12-21T06:44:23.376712Z",
"url": "https://files.pythonhosted.org/packages/11/8e/70be9a017256da753a7f5d3394fcc0df3b182e2f18197c505b26a5cbf57d/kolorjet-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ff32807bf296305fa23bb8e3927a57c3c7a03b1bfd0625593b6be41cb492138",
"md5": "7818895089604b5be570caf03ffe1361",
"sha256": "5e2d96ea9f74f30d63e6b6370fbc8fc0e882088178425824d8b3ba7f9db44b4b"
},
"downloads": -1,
"filename": "kolorjet-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7818895089604b5be570caf03ffe1361",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7260,
"upload_time": "2023-12-21T06:44:25",
"upload_time_iso_8601": "2023-12-21T06:44:25.446831Z",
"url": "https://files.pythonhosted.org/packages/3f/f3/2807bf296305fa23bb8e3927a57c3c7a03b1bfd0625593b6be41cb492138/kolorjet-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-21 06:44:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Samuel9360639",
"github_project": "kolorjet",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "kolorjet"
}
