# Bash color
## Available colors
- BLACK
- RED
- GREEN
- BROWN
- BLUE
- PURPLE
- CYAN
- LIGHT_GRAY
- DEFAULT
- DARK_GRAY
- LIGHT_RED
- LIGHT_GREEN
- YELLOW
- LIGHT_BLUE
- LIGHT_PURPLE
- LIGHT_CYAN
- WHITE
## Available effect
- BOLD
- DIM (not working on Konsole)
- UNDERLINE
- BLINK (not working on Konsole and Gnome Terminal)
- INVERSE
- HIDDEN (not working on Konsole)
## Example
```python
from bashcolor import RED, UNDERLINE, colorize
print(colorize('Red color', RED))
print(colorize('Red background', background=RED))
print(colorize('Underline', effects=[UNDERLINE]))
```
## API
```python
def colorize(
text,
color=None,
background=None,
effects=[],
color_256=None,
background_256=None,
with_end=True):
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sbrunner/bashcolor/",
"name": "bashcolor",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "St\u00e9phane Brunner",
"author_email": "stephane.brunner@gmail.com",
"download_url": "",
"platform": "",
"description": "# Bash color\n\n## Available colors\n\n- BLACK\n- RED\n- GREEN\n- BROWN\n- BLUE\n- PURPLE\n- CYAN\n- LIGHT_GRAY\n- DEFAULT\n- DARK_GRAY\n- LIGHT_RED\n- LIGHT_GREEN\n- YELLOW\n- LIGHT_BLUE\n- LIGHT_PURPLE\n- LIGHT_CYAN\n- WHITE\n\n## Available effect\n\n- BOLD\n- DIM (not working on Konsole)\n- UNDERLINE\n- BLINK (not working on Konsole and Gnome Terminal)\n- INVERSE\n- HIDDEN (not working on Konsole)\n\n## Example\n\n```python\nfrom bashcolor import RED, UNDERLINE, colorize\n\nprint(colorize('Red color', RED))\nprint(colorize('Red background', background=RED))\nprint(colorize('Underline', effects=[UNDERLINE]))\n```\n\n## API\n\n```python\ndef colorize(\n text,\n color=None,\n background=None,\n effects=[],\n color_256=None,\n background_256=None,\n with_end=True):\n```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple library to get colors in the bash terminal",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/sbrunner/bashcolor/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9200ebe438b30e933b1b8da0dfc4aecd9145c07ba7a7f53ecb63464de34a71f7",
"md5": "146f9ff540126f32920e8938f8a49f8e",
"sha256": "77f02f25dcf64bc6282985cf1f9c6b76019dbcfd2744dc02c86897b41350796b"
},
"downloads": -1,
"filename": "bashcolor-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "146f9ff540126f32920e8938f8a49f8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2954,
"upload_time": "2021-08-09T17:12:14",
"upload_time_iso_8601": "2021-08-09T17:12:14.418912Z",
"url": "https://files.pythonhosted.org/packages/92/00/ebe438b30e933b1b8da0dfc4aecd9145c07ba7a7f53ecb63464de34a71f7/bashcolor-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-08-09 17:12:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sbrunner",
"github_project": "bashcolor",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bashcolor"
}