# BeautifulTerminal
**BeautifulTerminal** is a Python library that automatically beautifies terminal output by adding colors based on the content of the messages. This library improves the readability of your console applications and makes it easier to understand log outputs and messages. No additional setup is required after importing!
## Features
- **Automatic Colors**:
- Errors are displayed in red.
- Warnings are displayed in yellow.
- Success messages are displayed in green.
- Regular messages are displayed in white.
- **Easy Integration**:
- Simply import the library, and it works immediately.
- **Customizable**:
- You can easily change the color codes to suit your preferences.
## Installation
To install the library, use `pip`:
```bash
pip install beautifull_terminal
```
## Getting Started
After installation, you can quickly use the library in your Python scripts. Follow these simple steps:
1. **Import the library**:
```python
import beautifull_terminal
```
2. **Print messages**:
Use the `print` function as usual. The library automatically applies the appropriate colors based on the content of your messages.
## Usage
Here are some examples of how to use the library:
```python
import beautifull_terminal
# Examples of using the library
print("This is a regular message.") # Default color: White
print("Error: Something went wrong!", color="red") # Error text in Red
print("Warning: Be careful!", color="yellow") # Warning in Yellow
print("Success: Operation completed!", color="green") # Success in Green
```
### Example Outputs
- Regular message: White
- Warning: Yellow
- Error: Red
- Success: Green
### Using the `color` Option
The `print` function in `BeautifulTerminal` supports an optional `color` parameter that lets you specify the color of the printed text directly. Example:
```python
import beautifull_terminal
print("This text is normal.") # Default color: White
print("This text is red!", color="red") # Text in Red
print("This text is yellow!", color="yellow") # Text in Yellow
print("This text is green!", color="green") # Text in Green
```
If you specify an invalid color, the default color is used. This gives you flexibility to customize the text to your liking.
## Customization
You can change the color codes in the library to modify the appearance of the outputs. This allows you to tailor the library to your preferred terminal design or personal preferences. Simply modify the `COLORS` dictionary in the `BeautifulTerminal` class.
## Disabling
If you need to temporarily disable color output, you can do so:
```python
import beautifull_terminal as bt
bt.disable() # Temporarily disable color output
```
To re-enable color output:
```python
bt.enable() # Re-enable color output
```
## Compatibility
The `BeautifulTerminal` library is compatible with any terminal that supports ANSI escape codes, which includes most modern terminal emulators. However, it may not work correctly on older systems or environments that do not support ANSI codes.
## Acknowledgments
- This library was inspired by the need for better readability of terminal outputs.
- Special thanks to the contributors and the open-source community for their continuous support and suggestions.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contributions
Contributions are welcome! If you have suggestions for improvements or additional features, feel free to open an issue or submit a pull request.
## Contact
For questions or feedback, please reach out to us through the [GitHub repository](https://github.com/StarGames2025/beautifull_terminal).
Raw data
{
"_id": null,
"home_page": "https://github.com/StarGames2025/beautifull_terminal",
"name": "beautifull-terminal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "terminal, color, beautify, print",
"author": "starcrusher2025",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/43/52/abf905ba9958adf504c66ed3992b98cdd5fa31929e1568961713fe8201d3/beautifull_terminal-1.9.11.tar.gz",
"platform": null,
"description": "# BeautifulTerminal\r\n\r\n**BeautifulTerminal** is a Python library that automatically beautifies terminal output by adding colors based on the content of the messages. This library improves the readability of your console applications and makes it easier to understand log outputs and messages. No additional setup is required after importing!\r\n\r\n## Features\r\n\r\n- **Automatic Colors**:\r\n - Errors are displayed in red.\r\n - Warnings are displayed in yellow.\r\n - Success messages are displayed in green.\r\n - Regular messages are displayed in white.\r\n\r\n- **Easy Integration**:\r\n - Simply import the library, and it works immediately.\r\n\r\n- **Customizable**:\r\n - You can easily change the color codes to suit your preferences.\r\n\r\n## Installation\r\n\r\nTo install the library, use `pip`:\r\n\r\n```bash\r\npip install beautifull_terminal\r\n```\r\n\r\n## Getting Started\r\n\r\nAfter installation, you can quickly use the library in your Python scripts. Follow these simple steps:\r\n\r\n1. **Import the library**:\r\n ```python\r\n import beautifull_terminal\r\n ```\r\n\r\n2. **Print messages**:\r\n Use the `print` function as usual. The library automatically applies the appropriate colors based on the content of your messages.\r\n\r\n## Usage\r\n\r\nHere are some examples of how to use the library:\r\n\r\n```python\r\nimport beautifull_terminal\r\n\r\n# Examples of using the library\r\nprint(\"This is a regular message.\") # Default color: White\r\nprint(\"Error: Something went wrong!\", color=\"red\") # Error text in Red\r\nprint(\"Warning: Be careful!\", color=\"yellow\") # Warning in Yellow\r\nprint(\"Success: Operation completed!\", color=\"green\") # Success in Green\r\n```\r\n\r\n### Example Outputs\r\n\r\n- Regular message: White\r\n- Warning: Yellow\r\n- Error: Red\r\n- Success: Green\r\n\r\n### Using the `color` Option\r\n\r\nThe `print` function in `BeautifulTerminal` supports an optional `color` parameter that lets you specify the color of the printed text directly. Example:\r\n\r\n```python\r\nimport beautifull_terminal\r\n\r\nprint(\"This text is normal.\") # Default color: White\r\nprint(\"This text is red!\", color=\"red\") # Text in Red\r\nprint(\"This text is yellow!\", color=\"yellow\") # Text in Yellow\r\nprint(\"This text is green!\", color=\"green\") # Text in Green\r\n```\r\n\r\nIf you specify an invalid color, the default color is used. This gives you flexibility to customize the text to your liking.\r\n\r\n## Customization\r\n\r\nYou can change the color codes in the library to modify the appearance of the outputs. This allows you to tailor the library to your preferred terminal design or personal preferences. Simply modify the `COLORS` dictionary in the `BeautifulTerminal` class.\r\n\r\n## Disabling\r\n\r\nIf you need to temporarily disable color output, you can do so:\r\n\r\n```python\r\nimport beautifull_terminal as bt\r\nbt.disable() # Temporarily disable color output\r\n```\r\n\r\nTo re-enable color output:\r\n\r\n```python\r\nbt.enable() # Re-enable color output\r\n```\r\n\r\n## Compatibility\r\n\r\nThe `BeautifulTerminal` library is compatible with any terminal that supports ANSI escape codes, which includes most modern terminal emulators. However, it may not work correctly on older systems or environments that do not support ANSI codes.\r\n\r\n## Acknowledgments\r\n\r\n- This library was inspired by the need for better readability of terminal outputs.\r\n- Special thanks to the contributors and the open-source community for their continuous support and suggestions.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\r\n\r\n## Contributions\r\n\r\nContributions are welcome! If you have suggestions for improvements or additional features, feel free to open an issue or submit a pull request.\r\n\r\n## Contact\r\n\r\nFor questions or feedback, please reach out to us through the [GitHub repository](https://github.com/StarGames2025/beautifull_terminal).\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Automatically beautify your terminal output with colors.",
"version": "1.9.11",
"project_urls": {
"Homepage": "https://github.com/StarGames2025/beautifull_terminal"
},
"split_keywords": [
"terminal",
" color",
" beautify",
" print"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5292a2596a92184fd51c17ce217d2448ecbba0896b8ce4ffaab4daaab7b5701c",
"md5": "19206c7302d1d086962ad210fbcaa121",
"sha256": "146a32d0322ca49719d762b8e751e07fd5a1e10abd4e12bc2950a3175c2a3e78"
},
"downloads": -1,
"filename": "beautifull_terminal-1.9.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "19206c7302d1d086962ad210fbcaa121",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4207,
"upload_time": "2024-11-12T12:21:42",
"upload_time_iso_8601": "2024-11-12T12:21:42.334610Z",
"url": "https://files.pythonhosted.org/packages/52/92/a2596a92184fd51c17ce217d2448ecbba0896b8ce4ffaab4daaab7b5701c/beautifull_terminal-1.9.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4352abf905ba9958adf504c66ed3992b98cdd5fa31929e1568961713fe8201d3",
"md5": "60fa06f504b7fa0672c41e77c56b0916",
"sha256": "b70e4c34ca1a4340f466104b3c6d42a27f9ad47a00694e0fe57d1fd3d9232c1f"
},
"downloads": -1,
"filename": "beautifull_terminal-1.9.11.tar.gz",
"has_sig": false,
"md5_digest": "60fa06f504b7fa0672c41e77c56b0916",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3984,
"upload_time": "2024-11-12T12:21:43",
"upload_time_iso_8601": "2024-11-12T12:21:43.271176Z",
"url": "https://files.pythonhosted.org/packages/43/52/abf905ba9958adf504c66ed3992b98cdd5fa31929e1568961713fe8201d3/beautifull_terminal-1.9.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 12:21:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StarGames2025",
"github_project": "beautifull_terminal",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "beautifull-terminal"
}
JSON
