| Name | str-style JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | https://github.com/esharf/str-style |
| Summary | str-style is a Python package for enhancing the visual appearance of text. Easily apply a variety of styles like bold, underline, colors, and more to your strings in both CLI and Python scripts. |
| upload_time | 2024-10-09 19:38:36 |
| maintainer | None |
| docs_url | None |
| author | esharf |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
style
collor
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://badge.fury.io/py/str-style) [](https://dashboard.guardrails.io/gh/esharf/repos/184958) [](https://codecov.io/gh/esharf/str-style)
# str-style
str-style is a Python package that provides string styling functions to enhance the visual appearance of text.
#### Usage
To use the str-style package in CLI, yoiu simply need to run the following:
```bash
str-style red Hello world
```
This will print the string "<span style="color: red">Hello world</span>" with red styling applied.
To use the str-style package in your own python script, follow these steps:
1. Import the desired styling function(s) from strstyle module.
2. Apply the styling function(s) to your string(s) to modify their appearance.
Here's an example of how to use the red styling function:
```python
>>> from strstyle import red
>>> print(red('Hello world'))
```
This will print the string "<span style="color: red">Hello world</span>" with red styling applied.
#### Available CLI Styling
- bold
- disabled
- italic
- underline
- sharp
- invisible
- strike-through
- double-underline
- black
- red
- green
- orange
- blue
- purple
- cyan
- light-grey
- red-background
- green-background
- yellow-background
- blue-background
- purple-background
- cyan-background
- light-grey-background
- dark-grey
- light-red
- yellow
- light-blue
- pink
- light-cyan
#### Available Styling Functions
- bold
- disabled
- italic
- underline
- sharp
- invisible
- strike_through
- double_underline
- black
- red
- green
- orange
- blue
- purple
- cyan
- light_grey
- red_background
- green_background
- yellow_background
- blue_background
- purple_background
- cyan_background
- light_grey_background
- dark_grey
- light_red
- yellow
- light_blue
- pink
- light_cyan
#### Contributing
Contributions to str-style are welcome! If you encounter any issues, have suggestions, or want to contribute improvements, please feel free to open an [issue](https://github.com/esharf/str-style/issues) or submit a [pull request](https://github.com/esharf/str-style/pulls).
#### License
This package is licensed under the MIT License. See the [LICENSE](https://github.com/esharf/str-style/blob/master/LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/esharf/str-style",
"name": "str-style",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "style, collor",
"author": "esharf",
"author_email": "57587340+esharf@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/60/96/35fba4ec6e301efac9e78b00ec41a95123c3344b870b42f42b5294fe57bd/str_style-1.0.1.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/str-style) [](https://dashboard.guardrails.io/gh/esharf/repos/184958) [](https://codecov.io/gh/esharf/str-style)\n# str-style\n\nstr-style is a Python package that provides string styling functions to enhance the visual appearance of text.\n\n#### Usage\n\nTo use the str-style package in CLI, yoiu simply need to run the following:\n```bash\nstr-style red Hello world\n```\n\nThis will print the string \"<span style=\"color: red\">Hello world</span>\" with red styling applied.\n\nTo use the str-style package in your own python script, follow these steps:\n\n1. Import the desired styling function(s) from strstyle module.\n2. Apply the styling function(s) to your string(s) to modify their appearance.\nHere's an example of how to use the red styling function:\n```python\n>>> from strstyle import red\n>>> print(red('Hello world'))\n```\n\nThis will print the string \"<span style=\"color: red\">Hello world</span>\" with red styling applied.\n\n#### Available CLI Styling\n- bold\n- disabled\n- italic\n- underline\n- sharp\n- invisible\n- strike-through\n- double-underline\n- black\n- red\n- green\n- orange\n- blue\n- purple\n- cyan\n- light-grey\n- red-background\n- green-background\n- yellow-background\n- blue-background\n- purple-background\n- cyan-background\n- light-grey-background\n- dark-grey\n- light-red\n- yellow\n- light-blue\n- pink\n- light-cyan\n\n#### Available Styling Functions\n- bold\n- disabled\n- italic\n- underline\n- sharp\n- invisible\n- strike_through\n- double_underline\n- black\n- red\n- green\n- orange\n- blue\n- purple\n- cyan\n- light_grey\n- red_background\n- green_background\n- yellow_background\n- blue_background\n- purple_background\n- cyan_background\n- light_grey_background\n- dark_grey\n- light_red\n- yellow\n- light_blue\n- pink\n- light_cyan\n\n\n#### Contributing\nContributions to str-style are welcome! If you encounter any issues, have suggestions, or want to contribute improvements, please feel free to open an [issue](https://github.com/esharf/str-style/issues) or submit a [pull request](https://github.com/esharf/str-style/pulls).\n\n#### License\nThis package is licensed under the MIT License. See the [LICENSE](https://github.com/esharf/str-style/blob/master/LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "str-style is a Python package for enhancing the visual appearance of text. Easily apply a variety of styles like bold, underline, colors, and more to your strings in both CLI and Python scripts.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/esharfr/str-style/issues",
"Homepage": "https://github.com/esharf/str-style",
"Repository": "https://github.com/esharf/str-style"
},
"split_keywords": [
"style",
" collor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28c4824bfe0107a09c3be2347b5aa34dc30542c7350f0467c2272ff19c63fbf2",
"md5": "02f1fe0a21f3f17552b8f2d80ecba15f",
"sha256": "c1795d1a8c9cf806eac259748c14ebdd56277ae8689c69cad919464db552cb17"
},
"downloads": -1,
"filename": "str_style-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02f1fe0a21f3f17552b8f2d80ecba15f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 4641,
"upload_time": "2024-10-09T19:38:34",
"upload_time_iso_8601": "2024-10-09T19:38:34.962730Z",
"url": "https://files.pythonhosted.org/packages/28/c4/824bfe0107a09c3be2347b5aa34dc30542c7350f0467c2272ff19c63fbf2/str_style-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "609635fba4ec6e301efac9e78b00ec41a95123c3344b870b42f42b5294fe57bd",
"md5": "b2afc783a32833840581586a527b2e73",
"sha256": "b613f2c3342452afcef5b607745f26649b71c22c4e4581de1f596b9a5fc82db4"
},
"downloads": -1,
"filename": "str_style-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b2afc783a32833840581586a527b2e73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 3628,
"upload_time": "2024-10-09T19:38:36",
"upload_time_iso_8601": "2024-10-09T19:38:36.610611Z",
"url": "https://files.pythonhosted.org/packages/60/96/35fba4ec6e301efac9e78b00ec41a95123c3344b870b42f42b5294fe57bd/str_style-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 19:38:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "esharf",
"github_project": "str-style",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "str-style"
}
