# pycolorise
- Add **colors/fonts** to the terminal
- The terminal colorizer is a tool that improves the visual experience of terminal applications
[![python badge](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/ "Python")
[![CodeQL](https://github.com/Modern-Realm/pycolorise/actions/workflows/codeql.yml/badge.svg)](https://github.com/Modern-Realm/pycolorise/actions/workflows/codeql.yml)
[![Generic badge](https://img.shields.io/badge/Python-3.7-blue.svg)](https://www.python.org/)
![Github License](https://img.shields.io/badge/license-MIT-blue)
![Windows](https://img.shields.io/badge/os-windows-yellow)
![Linux](https://img.shields.io/badge/os-linux-yellow)
Join [Official Discord Server](https://discord.gg/GVMWx5EaAN "click to Join") for more guidance !
# Features
- It provides **templates** for foreground, background colors and font styles for re-usability.
- It supports **24-bit true colors, RGB, and hex colors**, providing a wide range of color options.
- The colorizer is built using **object-oriented programming** principles, making it highly customizable.
- Developers can easily create their own color schemes to suit their needs.
- The colorizer has **no dependencies**, making it easy to integrate into any project without adding unnecessary
overhead.
# Installation
For stable version, use below command
```shell
pip install -U pycolorise
```
For latest/beta version, install it using `git`
```shell
pip install -U git+https://github.com/Modern-Realm/pycolorise
```
# Quickstart
Create a file with '.py ' extension, Like: **main.py**
```python
# For foreground colors
from pycolorise.colors import *
# For background colors
from pycolorise.bgColors import *
# For font styles like: bold, italic, etc
from pycolorise.styles import *
print(Purple("• Foreground colors:"))
print(
Red("red"), BrightRed("bred"),
Green("green"), BrightGreen("bgreen")
)
print(Purple("\n• Background colors:"))
print(
BgRed("red"), BgBrightRed("bred"),
BgGreen("green"), BgBrightGreen("bgreen")
)
print(Purple("\n• Fonts:"))
print(
Bold("bold"), Underline("underline"),
StrikeThrough("strike through"),
Italic("italic"), Framed("framed")
)
```
Output:
<img src="https://github.com/Modern-Realm/pycolorise/blob/main/images/output-1.png" alt="output">
# Useful Links:
- For more guidance check [Examples](https://github.com/Modern-Realm/pycolorise/tree/main/Examples)
- [Documentation](https://modern-realm.github.io/pycolorise/)
- [Contributing](https://github.com/Modern-Realm/pycolorise/blob/main/.github/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/Modern-Realm/pycolorise/blob/main/.github/CODE_OF_CONDUCT.md)
-----
# Contact Us
- [Discord](https://discord.gg/GVMWx5EaAN) • [Github](https://github.com/skrphenix) • [Gmail](mailto:saikeerthan.keerthan.9@gmail.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/Modern-Realm/pycolorise",
"name": "pycolorise",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "colors,terminal colors,pycolorise",
"author": "P. Sai Keerthan Reddy",
"author_email": "saikeerthan.keerthan.9@gmail.com",
"download_url": "",
"platform": null,
"description": "# pycolorise\r\n\r\n- Add **colors/fonts** to the terminal\r\n- The terminal colorizer is a tool that improves the visual experience of terminal applications\r\n\r\n[![python badge](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/ \"Python\")\r\n\r\n[![CodeQL](https://github.com/Modern-Realm/pycolorise/actions/workflows/codeql.yml/badge.svg)](https://github.com/Modern-Realm/pycolorise/actions/workflows/codeql.yml)\r\n[![Generic badge](https://img.shields.io/badge/Python-3.7-blue.svg)](https://www.python.org/)\r\n![Github License](https://img.shields.io/badge/license-MIT-blue)\r\n![Windows](https://img.shields.io/badge/os-windows-yellow)\r\n![Linux](https://img.shields.io/badge/os-linux-yellow)\r\n\r\nJoin [Official Discord Server](https://discord.gg/GVMWx5EaAN \"click to Join\") for more guidance !\r\n\r\n# Features\r\n\r\n- It provides **templates** for foreground, background colors and font styles for re-usability.\r\n\r\n- It supports **24-bit true colors, RGB, and hex colors**, providing a wide range of color options.\r\n\r\n- The colorizer is built using **object-oriented programming** principles, making it highly customizable.\r\n\r\n- Developers can easily create their own color schemes to suit their needs.\r\n\r\n- The colorizer has **no dependencies**, making it easy to integrate into any project without adding unnecessary\r\n overhead.\r\n\r\n# Installation\r\n\r\nFor stable version, use below command\r\n\r\n```shell\r\npip install -U pycolorise\r\n```\r\n\r\nFor latest/beta version, install it using `git`\r\n\r\n```shell\r\npip install -U git+https://github.com/Modern-Realm/pycolorise\r\n```\r\n\r\n# Quickstart\r\n\r\nCreate a file with '.py ' extension, Like: **main.py**\r\n\r\n```python\r\n# For foreground colors\r\nfrom pycolorise.colors import *\r\n# For background colors\r\nfrom pycolorise.bgColors import *\r\n# For font styles like: bold, italic, etc\r\nfrom pycolorise.styles import *\r\n\r\nprint(Purple(\"\u2022 Foreground colors:\"))\r\nprint(\r\n Red(\"red\"), BrightRed(\"bred\"),\r\n Green(\"green\"), BrightGreen(\"bgreen\")\r\n)\r\n\r\nprint(Purple(\"\\n\u2022 Background colors:\"))\r\nprint(\r\n BgRed(\"red\"), BgBrightRed(\"bred\"),\r\n BgGreen(\"green\"), BgBrightGreen(\"bgreen\")\r\n)\r\n\r\nprint(Purple(\"\\n\u2022 Fonts:\"))\r\nprint(\r\n Bold(\"bold\"), Underline(\"underline\"),\r\n StrikeThrough(\"strike through\"),\r\n Italic(\"italic\"), Framed(\"framed\")\r\n)\r\n```\r\n\r\nOutput:\r\n\r\n<img src=\"https://github.com/Modern-Realm/pycolorise/blob/main/images/output-1.png\" alt=\"output\">\r\n\r\n# Useful Links:\r\n\r\n- For more guidance check [Examples](https://github.com/Modern-Realm/pycolorise/tree/main/Examples)\r\n- [Documentation](https://modern-realm.github.io/pycolorise/)\r\n- [Contributing](https://github.com/Modern-Realm/pycolorise/blob/main/.github/CONTRIBUTING.md)\r\n- [Code of Conduct](https://github.com/Modern-Realm/pycolorise/blob/main/.github/CODE_OF_CONDUCT.md)\r\n\r\n-----\r\n\r\n# Contact Us\r\n\r\n- [Discord](https://discord.gg/GVMWx5EaAN) \u2022 [Github](https://github.com/skrphenix) \u2022 [Gmail](mailto:saikeerthan.keerthan.9@gmail.com)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add colors to the terminal",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/Modern-Realm/pycolorise/issues",
"Discord Server": "https://discord.gg/GVMWx5EaAN",
"Documentation": "https://modern-realm.github.io/pycolorise/",
"Examples": "https://github.com/Modern-Realm/pycolorise/tree/main/Examples",
"Homepage": "https://github.com/Modern-Realm/pycolorise",
"Source": "https://github.com/Modern-Realm/pycolorise/tree/main/package/pycolorise"
},
"split_keywords": [
"colors",
"terminal colors",
"pycolorise"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "caed2452fdaad3bdbaf53ab509c8e0880ad18381a492d1a60cbb3da8fae21df3",
"md5": "079cab9932161745f3f449189e947c36",
"sha256": "78e710151bdbb4936e2bc44336d390696c3e1fd892ccac92552210960e74daba"
},
"downloads": -1,
"filename": "pycolorise-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "079cab9932161745f3f449189e947c36",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12263,
"upload_time": "2023-05-06T15:00:36",
"upload_time_iso_8601": "2023-05-06T15:00:36.369559Z",
"url": "https://files.pythonhosted.org/packages/ca/ed/2452fdaad3bdbaf53ab509c8e0880ad18381a492d1a60cbb3da8fae21df3/pycolorise-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-06 15:00:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Modern-Realm",
"github_project": "pycolorise",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pycolorise"
}