# bruhcolor
[](https://pypi.org/project/bruhcolor/)
[](https://pepy.tech/project/bruhcolor)
[](https://pepy.tech/project/bruhcolor)
[](https://pepy.tech/project/bruhcolor)
[](https://badge.fury.io/py/bruhcolor)
[](https://opensource.org/licenses/MIT)
bruhcolor is a Python package that allows you to color text in the terminal. It supports both 8-color and 256-color formatting, providing a wide range of colors to choose from. The package is available on PYPI and is licensed under the MIT license.
## Installation
To install bruhcolor, you can use pip:
```shell
pip install bruhcolor
```
## Usage
To use bruhcolor, simply import the `bruhcolored` function from the package:
```python
from bruhcolor import bruhcolored
```
You can then use the `bruhcolored` function to color your text. Here's an example:
```python
colored_text = bruhcolored("Hello world!", color="red", on_color=194, attrs=["bold", "blink"])
print(colored_text)
```
This will output the text "Hello world!" in red color, with a background color of 194 and the attributes "bold" and "blink" applied.
## Available Colors
bruhcolor supports a wide range of colors. You can use either the 8-color or 256-color formatting. Here are some examples of available colors:
- 8-color: black, grey, red, green, yellow, blue, magenta, cyan, light_grey, dark_grey, light_red, light_green, light_yellow, light_blue, light_magenta, light_cyan, white
- 256-color: You can use any number between 0 and 255 to specify a color.
To see a full list of available colors, you can use the `colors` function:
```python
from bruhcolor import colors
colors(support="full")
```
This will print out all the available colors.
## Available Attributes
bruhcolor also supports various attributes that you can apply to your text. Here are some examples of available attributes:
- bold
- dark
- italic
- underline
- blink
- reverse
- concealed
- crossed-out
To see a full list of available attributes, you can use the `valid_effects` function:
```python
from bruhcolor import valid_effects
valid_effects()
```
This will print out all the available attributes.
## License
bruhcolor is licensed under the MIT License. See [LICENSE](https://github.com/FNBBDevs/bruhcolor/blob/main/COPYING.txt) for more information.
Raw data
{
"_id": null,
"home_page": "",
"name": "bruhcolor",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,terminal,text coloring,bruhcolor",
"author": "Ethan Christensen",
"author_email": "ethanlchristensen@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/76/39/7e6fdf2faf030655867236aa063505538b9120234bc1e814e82aa2194fe2/bruhcolor-0.0.64.tar.gz",
"platform": null,
"description": "\r\n# bruhcolor\r\r\n\r\r\n[](https://pypi.org/project/bruhcolor/)\r\r\n[](https://pepy.tech/project/bruhcolor)\r\r\n[](https://pepy.tech/project/bruhcolor)\r\r\n[](https://pepy.tech/project/bruhcolor)\r\r\n[](https://badge.fury.io/py/bruhcolor)\r\r\n[](https://opensource.org/licenses/MIT)\r\r\n\r\r\nbruhcolor is a Python package that allows you to color text in the terminal. It supports both 8-color and 256-color formatting, providing a wide range of colors to choose from. The package is available on PYPI and is licensed under the MIT license.\r\r\n\r\r\n## Installation\r\r\n\r\r\nTo install bruhcolor, you can use pip:\r\r\n\r\r\n```shell\r\r\npip install bruhcolor\r\r\n```\r\r\n\r\r\n## Usage\r\r\n\r\r\nTo use bruhcolor, simply import the `bruhcolored` function from the package:\r\r\n\r\r\n```python\r\r\nfrom bruhcolor import bruhcolored\r\r\n```\r\r\n\r\r\nYou can then use the `bruhcolored` function to color your text. Here's an example:\r\r\n\r\r\n```python\r\r\ncolored_text = bruhcolored(\"Hello world!\", color=\"red\", on_color=194, attrs=[\"bold\", \"blink\"])\r\r\n\r\r\nprint(colored_text)\r\r\n```\r\r\n\r\r\nThis will output the text \"Hello world!\" in red color, with a background color of 194 and the attributes \"bold\" and \"blink\" applied.\r\r\n\r\r\n## Available Colors\r\r\n\r\r\nbruhcolor supports a wide range of colors. You can use either the 8-color or 256-color formatting. Here are some examples of available colors:\r\r\n\r\r\n- 8-color: black, grey, red, green, yellow, blue, magenta, cyan, light_grey, dark_grey, light_red, light_green, light_yellow, light_blue, light_magenta, light_cyan, white\r\r\n- 256-color: You can use any number between 0 and 255 to specify a color.\r\r\n\r\r\nTo see a full list of available colors, you can use the `colors` function:\r\r\n\r\r\n```python\r\r\nfrom bruhcolor import colors\r\r\n\r\r\ncolors(support=\"full\")\r\r\n```\r\r\n\r\r\nThis will print out all the available colors.\r\r\n\r\r\n## Available Attributes\r\r\n\r\r\nbruhcolor also supports various attributes that you can apply to your text. Here are some examples of available attributes:\r\r\n\r\r\n- bold\r\r\n- dark\r\r\n- italic\r\r\n- underline\r\r\n- blink\r\r\n- reverse\r\r\n- concealed\r\r\n- crossed-out\r\r\n\r\r\nTo see a full list of available attributes, you can use the `valid_effects` function:\r\r\n\r\r\n```python\r\r\nfrom bruhcolor import valid_effects\r\r\n\r\r\nvalid_effects()\r\r\n```\r\r\n\r\r\nThis will print out all the available attributes.\r\r\n\r\r\n## License\r\r\n\r\r\nbruhcolor is licensed under the MIT License. See [LICENSE](https://github.com/FNBBDevs/bruhcolor/blob/main/COPYING.txt) for more information.\r\r\n",
"bugtrack_url": null,
"license": "",
"summary": "256 Color Terminal Text Formatter",
"version": "0.0.64",
"project_urls": null,
"split_keywords": [
"python",
"terminal",
"text coloring",
"bruhcolor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76397e6fdf2faf030655867236aa063505538b9120234bc1e814e82aa2194fe2",
"md5": "7883181be87af61c4232650b2207089e",
"sha256": "9e01b76c24705543e34bff870debfaadc0342ce4538a56a7757d06f4ca06f3dc"
},
"downloads": -1,
"filename": "bruhcolor-0.0.64.tar.gz",
"has_sig": false,
"md5_digest": "7883181be87af61c4232650b2207089e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5824,
"upload_time": "2023-12-09T21:54:15",
"upload_time_iso_8601": "2023-12-09T21:54:15.943978Z",
"url": "https://files.pythonhosted.org/packages/76/39/7e6fdf2faf030655867236aa063505538b9120234bc1e814e82aa2194fe2/bruhcolor-0.0.64.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 21:54:15",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bruhcolor"
}
JSON