# Pixel Pretender
**A Python package for rendering pixelated text in the console, with customizable ASCII and Unicode\* symbols and optional color formatting.**
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Support Functions](#support-functions)
- [Help](#need-help-with-a-specific-function)
- [Notes](#notes)
- [Contributing](#contributing)
- [Author](#author)
- [Licenses](#licenses)
- [Acknowledgements](#acknowledgements)
## Features
- **Transform** text into pixelated representations using customizable symbols.
- Enhance color customization with **rich and colorama libraries**.
- **Simple functions for rendering and displaying pixel text with style.**
- **User friendly API**
## Installation
- To install the latest version of `pixel_pretender`, run:
```bash
pip install pixel-pretender
```
## Usage
- - adjust maximum number of pixel characters to display to your screen
```python
import pixel_pretender as pxp
# Determine the maximum number of pixel characters your screen can display.
pxp.max_display_capacity()
# Set the maximum number of pixel characters to display per line.
pxp.set_max_pixels(20)
```
- - using `pxp.digitise()` function to Transform text into its pixelated form.
```python
import pixel_pretender as pxp
# Text to be pixelated
text = "hello world"
# Convert text to pixels.
pixels = pxp.digitise(text, symbol='█')
# Display the pixelated text.
pxp.display_pixels(pixels)
```
- - Use the `pxp.digitise()` function with the `negative_image=True` option to invert the image, swapping whitespace with the symbol.
```python
import pixel_pretender as pxp
# Text to be pixelated
text = "hello world"
# Generate a negative image of the pixelated text.
pixels = pxp.digitise(text, symbol='█', negative_image=True)
# Display the negative image.
pxp.display_pixels(pixels)
```
**Pixelated text output with** `negative_image=True`
### Colorama Color Function:
**Apply 16 standard colors to your pixel characters using colorama.**
The following colors are available:
+ *'red', 'yellow', 'green', 'blue', 'cyan', 'magenta', 'black', 'white'*
+ *'light red', 'light yellow', 'light green', 'light blue', 'light cyan', 'light magenta', 'light black', 'light white'*
```python
import pixel_pretender as pxp
# Transform text into its pixelated form
pixels = pxp.digitise("> python 3.8 <", symbol='▄')
# Apply a color to the pixel characters using colorama (16 available colors).
colorama_pixels = pxp.apply_colorama_color(pixels, "yellow")
# Display the colorized pixel text.
pxp.display_pixels(colorama_pixels)
```
### Applying Colorama Colors in a Loop:
**Apply multiple colors to the same pixel text in sequence.**
```python
import pixel_pretender as pxp
# Transform text into its pixelated form
pixels = pxp.digitise("21:30", symbol='┇')
# Tuple containing all available colorama color names.
colors = pxp.colorama_colors
# Loop through colors and apply each to the pixel text.
for color in colors:
# Apply the current color to the pixel characters.
colorama_pixels = pxp.apply_colorama_color(pixels, color)
# Display the pixel text with the applied color.
pxp.display_pixels(colorama_pixels)
```
### Rich Color Function
**The Rich color library provides advanced coloring options that you can apply to customize your pixel characters.**
- **Without Background**
```python
import pixel_pretender as pxp
# Generate pixel list
pixels = pxp.digitise("pixel pretender", symbol='▓')
# Apply Rich color: True Color, 256 Colors, Basic Colors
rich_pixels = pxp.apply_rich_color(pixels, text_color="#ffff87") # Note: PyCharm users should run their script in the terminal to view Rich colors
# Display the result
pxp.display_pixels(rich_pixels)
```
- **With Background**
```python
import pixel_pretender as pxp
# Generate pixel list
pixels = pxp.digitise("pixel pretender", symbol='▓')
# Apply Rich color with background: True Color, 256 Colors, Basic Colors
rich_pixels = pxp.apply_rich_color(pixels, text_color="#ffff87", background_color="color(4)") # Note: PyCharm users should run their script in the terminal to view Rich colors
# Display the result
pxp.display_pixels(rich_pixels)
```
## Support Functions
<details>
<summary><b><code> max_display_capacity() </code></b></summary>
<i>Determines the maximum number of pixel characters your screen can display and helps you optimize the display settings for your pixelated text.
</i>
```python
import pixel_pretender as pxp
# Check the maximum display capacity for your screen.
pxp.max_display_capacity()
```
</details>
<details>
<summary><b><code> set_max_pixels() </code></b></summary>
<i><br>Allows you to customize the number of pixel characters displayed per line by setting a positive integer value. This ensures your pixelated text fits your screen perfectly.
</i>
```python
import pixel_pretender as pxp
# Define the maximum number of pixels per line based on your screen capacity.
user_max_pixels = 27
# Set the maximum pixel limit for display.
pxp.set_max_pixels(user_max_pixels)
```
</details>
<details>
<summary><b><code> try_pixel_samples() </code></b></summary>
<i><br>
Displays a test phrase in pixelated form using various symbols. The function shows the symbols in customizable increments, allowing you to experiment with different styles interactively.
</i>
```python
import pixel_pretender as pxp
# Display the test phrase using a series of different pixel symbols.
pxp.try_pixel_samples(test_phrase="test - 1234567890", increment=10, try_all=False)
```
<li><code>test_phrase:</code><b> The phrase to be represented in pixels. > <em>Default is "test - 1234567890"</em>.</b></li>
<li><code>increment (int):</code><b> Number of symbols to display before prompting for user input. > <em>Default is 10.</em></b></li>
<li><code>try_all (bool):</code><b> If True, uses the entire custom_pixel_list instead of the default increments. > <em>Default is False.</em></b></li>
<li><code>custom_pixel_list (list):</code><b> A custom list of symbols to be used for pixel representation. > <em>Default is pixel_samples.</em></b></li><br>
<img src="https://raw.githubusercontent.com/AnasseGX/Pixel_pretender/refs/heads/master/Docs/try_some_pixels.png" alt="">
</details>
<details>
<summary><b><code> try_rich_colors() </code></b></summary>
<i><br>
Showcases a test phrase using 255 rich color styles, letting users explore and preview color customization options.
</i>
```python
import pixel_pretender as pxp
# Display the test phrase using 255 Rich colors for a full range of color effects.
pxp.try_rich_colors(test_phrase="test - 1234567890", increment=10, try_all=False)
```
<li><code>test_phrase:</code><b> The phrase to be represented in rich colors. <em> > Default is "test - 1234567890"</em>.</b></li>
<li><code>increment (int):</code><b> Number of colors to display before prompting for user input. > <em>Default is 10.</em></b></li>
<li><code>try_all (bool):</code><b> If True, displays all colors instead of the default increments ><em> Default is False.</em></b></li>
<br>
<img src="https://raw.githubusercontent.com/AnasseGX/Pixel_pretender/refs/heads/master/Docs/try_rich_colors.png" alt=>
</details>
## Available Features for Users
<details>
<summary><b><code> colorama_colors </code></b></summary>
<i><br>A tuple of all color names available in Colorama, allowing you to easily apply colors to your pixel text.</i>
```python
import pixel_pretender as pxp
# Display all available Colorama color names.
print(pxp.colorama_colors)
```
- ***result:***
`('red', 'yellow', 'green', 'blue', 'cyan', 'magenta', 'black', 'white', 'light red', 'light yellow', 'light green', 'light blue', 'light cyan', 'light magenta', 'light black', 'light white')`
</details>
<details>
<summary><b><code> rich_colors </code></b></summary>
<i><br> A tuple containing 16 color names available in the Rich library for quick access and application to your pixel text.</i>
```python
import pixel_pretender as pxp
# Display the 16 basic color names available in Rich.
print(pxp.rich_colors)
```
- ***result:***
`('red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'black', 'bright_red', 'bright_green', 'bright_yellow', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white', 'bright_black')`
</details>
<details>
<summary><b><code> pixel_samples </code></b></summary>
<i><br>A list of Unicode symbols that can be used as pixel characters,
ensuring compatibility across various terminals.</i>
```python
import pixel_pretender as pxp
# Display all compatible Unicode symbols for pixel representation.
print(pxp.pixel_samples)
```
- ***result:***
`['┞', '┬', 'α', '▄', 'Ζ', 'τ', '┘', 'ß', '●', '○', '┟', 'Θ', 'ά', '◫', '┅', '¶', '╘', '►', '╂', 'Δ', '⌷', '₽', 'Ρ', '━', '◶', 'μ', '▛', '█', ...]`
</details>
<details>
<summary><b><code> cool_pixel_samples </code></b></summary>
<i><br> A curated list of Unicode symbols that are visually appealing and work well as pixel characters.</i>
```python
import pixel_pretender as pxp
# Display a selection of recommended symbols for pixelated text.
print(pxp.cool_pixel_samples)
```
- ***result:***
`['╳', '╲', '╱', '╮', '╵', '▄', '▅', '▆', '▇', '█', '▉', '▝', '▚', '▖', '▓', '▒', '░', '▐', '□', '▪', '■', '▟','◆', '◇', '◉', '○', '◎', '●', ...]`
</details>
## Need Help with a Specific Function?
- **To get detailed information on any function, use Python's built-in `help()` function on the function name.**
- **For example:**
```python
import pixel_pretender as pxp
help(pxp.apply_colorama_color)
```
- - **result:**
```
Help on function apply_colorama_color in module pixel_pretender:
apply_colorama_color(pixel_list, color)
Applies a specified text color to a list of pixel strings using Colorama.
Parameters:
- pixel_list (list of str): A list of pixel strings to color.
- color (str): A color name that specifies the text color to be applied. (e.g., "red", "blue", "light green").
- A tuple containing all available color names from the colorama library is stored in colorama_colors
Returns:
- list of str: A new list of pixel strings with the specified text color applied to the first
line and a reset applied to the last line.
Raises:
- TypeError: If pixel_list is not a list of strings or if color is not a string.
- ValueError: If color is not in colorama_colors.
```
## Notes
- Unicode* :
- **Some Unicode symbols may not display correctly due to varying spacing compared to ASCII letters**
- Rich Library :
- **PyCharm users should enable the “Emulate terminal in output console” option in the run/debug configuration, or run the program in the terminal to view the styled output.**
## Contributing
**This project is maintained as time and resources permit, However, the community is encouraged to contribute, fork, and modify the code freely. Contributions are always welcome and appreciated.**
***You are encouraged to:***
- Submit pull requests for bug fixes or feature enhancements.
- Fork the repository and adapt it to suit your needs.
There are no strict guidelines or requirements for contributing,
this project is now a collaborative effort for the benefit of the community. ***However, please note that approving pull requests may take some time.***
### Publishing to PyPI
This project is published on PyPI as `pixel_pretender`. If you contribute a significant feature and would like to publish it, please request to be added as a maintainer on PyPI by opening an issue. Alternatively, feel free to fork this project and publish your version independently.
## Author
Created by [Anasse Gassab](https://github.com/AnasseGX).
## Licenses
- **Pixel_Pretender** is licensed under the MIT License - see the [LICENSE](https://github.com/AnasseGX/Pixel_pretender/blob/master/LICENSE%20.txt) file for details.
- **Colorama** is licensed under the BSD license. See [Colorama License](https://github.com/tartley/colorama/blob/master/LICENSE.txt) for details.
- **Rich** is licensed under the MIT license. See [Rich License](https://github.com/Textualize/rich/blob/master/LICENSE) for details.
## Acknowledgements
- This project uses the [Colorama](https://pypi.org/project/colorama/) library for basic terminal color support.
- This project uses the [Rich](https://pypi.org/project/rich/) library for advanced text formatting and styling in the terminal.
- ***Thanks to the Python community for the awesome libraries like `colorama` and `rich`.***
- Inspired by Seven Segment Displays, ASCII art and creative console designs.
Raw data
{
"_id": null,
"home_page": "https://github.com/AnasseGX/Pixel_pretender",
"name": "pixel-pretender",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": null,
"keywords": "ASCII Unicode pixel art terminal text rendering color formatting",
"author": "Anasse Gassab",
"author_email": "anasse.gsb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/32/44/c5e1a078f0bb731ccdfef807bb902824eeb4ef9d913c104a80755d019575/pixel_pretender-1.0.1.tar.gz",
"platform": null,
"description": "# Pixel Pretender\r\n\r\n**A Python package for rendering pixelated text in the console, with customizable ASCII and Unicode\\* symbols and optional color formatting.**\r\n\r\n## Table of Contents\r\n- [Features](#features)\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n- [Support Functions](#support-functions) \r\n- [Help](#need-help-with-a-specific-function)\r\n- [Notes](#notes)\r\n- [Contributing](#contributing)\r\n- [Author](#author)\r\n- [Licenses](#licenses)\r\n- [Acknowledgements](#acknowledgements)\r\n\r\n## Features\r\n- **Transform** text into pixelated representations using customizable symbols.\r\n- Enhance color customization with **rich and colorama libraries**.\r\n- **Simple functions for rendering and displaying pixel text with style.**\r\n- **User friendly API**\r\n\r\n## Installation\r\n\r\n- To install the latest version of `pixel_pretender`, run:\r\n\r\n```bash\r\npip install pixel-pretender\r\n```\r\n\r\n## Usage\r\n- - adjust maximum number of pixel characters to display to your screen \r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Determine the maximum number of pixel characters your screen can display.\r\npxp.max_display_capacity()\r\n\r\n# Set the maximum number of pixel characters to display per line.\r\npxp.set_max_pixels(20)\r\n```\r\n\r\n- - using `pxp.digitise()` function to Transform text into its pixelated form.\r\n```python\r\nimport pixel_pretender as pxp \r\n# Text to be pixelated\r\ntext = \"hello world\"\r\n\r\n# Convert text to pixels.\r\npixels = pxp.digitise(text, symbol='\u2588')\r\n\r\n# Display the pixelated text.\r\npxp.display_pixels(pixels)\r\n```\r\n\r\n\r\n\r\n- - Use the `pxp.digitise()` function with the `negative_image=True` option to invert the image, swapping whitespace with the symbol.\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Text to be pixelated\r\ntext = \"hello world\"\r\n# Generate a negative image of the pixelated text.\r\npixels = pxp.digitise(text, symbol='\u2588', negative_image=True)\r\n\r\n# Display the negative image.\r\npxp.display_pixels(pixels)\r\n```\r\n\r\n**Pixelated text output with** `negative_image=True`\r\n\r\n\r\n\r\n\r\n### Colorama Color Function:\r\n**Apply 16 standard colors to your pixel characters using colorama.**\r\n\r\nThe following colors are available:\r\n\r\n+ *'red', 'yellow', 'green', 'blue', 'cyan', 'magenta', 'black', 'white'*\r\n+ *'light red', 'light yellow', 'light green', 'light blue', 'light cyan', 'light magenta', 'light black', 'light white'*\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Transform text into its pixelated form\r\npixels = pxp.digitise(\"> python 3.8 <\", symbol='\u2584')\r\n\r\n# Apply a color to the pixel characters using colorama (16 available colors).\r\ncolorama_pixels = pxp.apply_colorama_color(pixels, \"yellow\")\r\n\r\n# Display the colorized pixel text.\r\npxp.display_pixels(colorama_pixels)\r\n```\r\n\r\n\r\n\r\n### Applying Colorama Colors in a Loop:\r\n\r\n**Apply multiple colors to the same pixel text in sequence.**\r\n\r\n```python\r\nimport pixel_pretender as pxp\r\n\r\n# Transform text into its pixelated form\r\npixels = pxp.digitise(\"21:30\", symbol='\u2507')\r\n\r\n# Tuple containing all available colorama color names.\r\ncolors = pxp.colorama_colors\r\n\r\n# Loop through colors and apply each to the pixel text.\r\nfor color in colors:\r\n # Apply the current color to the pixel characters.\r\n colorama_pixels = pxp.apply_colorama_color(pixels, color)\r\n \r\n # Display the pixel text with the applied color.\r\n pxp.display_pixels(colorama_pixels)\r\n```\r\n\r\n\r\n\r\n### Rich Color Function\r\n\r\n**The Rich color library provides advanced coloring options that you can apply to customize your pixel characters.**\r\n\r\n- **Without Background**\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Generate pixel list \r\npixels = pxp.digitise(\"pixel pretender\", symbol='\u2593')\r\n\r\n# Apply Rich color: True Color, 256 Colors, Basic Colors\r\nrich_pixels = pxp.apply_rich_color(pixels, text_color=\"#ffff87\") # Note: PyCharm users should run their script in the terminal to view Rich colors\r\n\r\n# Display the result \r\npxp.display_pixels(rich_pixels)\r\n```\r\n\r\n\r\n- **With Background**\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Generate pixel list \r\npixels = pxp.digitise(\"pixel pretender\", symbol='\u2593')\r\n\r\n# Apply Rich color with background: True Color, 256 Colors, Basic Colors\r\nrich_pixels = pxp.apply_rich_color(pixels, text_color=\"#ffff87\", background_color=\"color(4)\") # Note: PyCharm users should run their script in the terminal to view Rich colors\r\n\r\n# Display the result \r\npxp.display_pixels(rich_pixels)\r\n```\r\n\r\n\r\n## Support Functions\r\n\r\n<details>\r\n <summary><b><code> max_display_capacity() </code></b></summary>\r\n\r\n<i>Determines the maximum number of pixel characters your screen can display and helps you optimize the display settings for your pixelated text.\r\n</i>\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Check the maximum display capacity for your screen.\r\npxp.max_display_capacity()\r\n```\r\n</details>\r\n\r\n<details> \r\n <summary><b><code> set_max_pixels() </code></b></summary> \r\n<i><br>Allows you to customize the number of pixel characters displayed per line by setting a positive integer value. This ensures your pixelated text fits your screen perfectly.\r\n</i>\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Define the maximum number of pixels per line based on your screen capacity.\r\nuser_max_pixels = 27\r\n\r\n# Set the maximum pixel limit for display.\r\npxp.set_max_pixels(user_max_pixels)\r\n```\r\n</details>\r\n\r\n<details>\r\n <summary><b><code> try_pixel_samples() </code></b></summary> \r\n<i><br>\r\nDisplays a test phrase in pixelated form using various symbols. The function shows the symbols in customizable increments, allowing you to experiment with different styles interactively.\r\n\r\n</i>\r\n\r\n```python\r\nimport pixel_pretender as pxp\r\n\r\n# Display the test phrase using a series of different pixel symbols.\r\npxp.try_pixel_samples(test_phrase=\"test - 1234567890\", increment=10, try_all=False)\r\n```\r\n\r\n<li><code>test_phrase:</code><b> The phrase to be represented in pixels. > <em>Default is \"test - 1234567890\"</em>.</b></li>\r\n<li><code>increment (int):</code><b> Number of symbols to display before prompting for user input. > <em>Default is 10.</em></b></li>\r\n<li><code>try_all (bool):</code><b> If True, uses the entire custom_pixel_list instead of the default increments. > <em>Default is False.</em></b></li>\r\n<li><code>custom_pixel_list (list):</code><b> A custom list of symbols to be used for pixel representation. > <em>Default is pixel_samples.</em></b></li><br>\r\n<img src=\"https://raw.githubusercontent.com/AnasseGX/Pixel_pretender/refs/heads/master/Docs/try_some_pixels.png\" alt=\"\">\r\n</details>\r\n\r\n<details>\r\n <summary><b><code> try_rich_colors() </code></b></summary> \r\n<i><br>\r\nShowcases a test phrase using 255 rich color styles, letting users explore and preview color customization options.\r\n</i>\r\n\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Display the test phrase using 255 Rich colors for a full range of color effects.\r\npxp.try_rich_colors(test_phrase=\"test - 1234567890\", increment=10, try_all=False)\r\n```\r\n\r\n<li><code>test_phrase:</code><b> The phrase to be represented in rich colors. <em> > Default is \"test - 1234567890\"</em>.</b></li>\r\n<li><code>increment (int):</code><b> Number of colors to display before prompting for user input. > <em>Default is 10.</em></b></li>\r\n<li><code>try_all (bool):</code><b> If True, displays all colors instead of the default increments ><em> Default is False.</em></b></li>\r\n<br>\r\n<img src=\"https://raw.githubusercontent.com/AnasseGX/Pixel_pretender/refs/heads/master/Docs/try_rich_colors.png\" alt=>\r\n</details>\r\n\r\n## Available Features for Users\r\n\r\n\r\n\r\n<details>\r\n <summary><b><code> colorama_colors </code></b></summary>\r\n<i><br>A tuple of all color names available in Colorama, allowing you to easily apply colors to your pixel text.</i>\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Display all available Colorama color names.\r\nprint(pxp.colorama_colors)\r\n```\r\n- ***result:***\r\n`('red', 'yellow', 'green', 'blue', 'cyan', 'magenta', 'black', 'white', 'light red', 'light yellow', 'light green', 'light blue', 'light cyan', 'light magenta', 'light black', 'light white')`\r\n\r\n</details>\r\n\r\n<details>\r\n <summary><b><code> rich_colors </code></b></summary> \r\n<i><br> A tuple containing 16 color names available in the Rich library for quick access and application to your pixel text.</i>\r\n\r\n```python\r\nimport pixel_pretender as pxp \r\n\r\n# Display the 16 basic color names available in Rich.\r\nprint(pxp.rich_colors)\r\n```\r\n- ***result:***\r\n`('red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'black', 'bright_red', 'bright_green', 'bright_yellow', 'bright_blue', 'bright_magenta', 'bright_cyan', 'bright_white', 'bright_black')`\r\n</details>\r\n\r\n<details>\r\n <summary><b><code> pixel_samples </code></b></summary>\r\n<i><br>A list of Unicode symbols that can be used as pixel characters,\r\nensuring compatibility across various terminals.</i>\r\n\r\n```python\r\nimport pixel_pretender as pxp\r\n\r\n# Display all compatible Unicode symbols for pixel representation.\r\nprint(pxp.pixel_samples)\r\n```\r\n- ***result:***\r\n`['\u251e', '\u252c', '\u03b1', '\u2584', '\u0396', '\u03c4', '\u2518', '\u00df', '\u25cf', '\u25cb', '\u251f', '\u0398', '\u03ac', '\u25eb', '\u2505', '\u00b6', '\u2558', '\u25ba', '\u2542', '\u0394', '\u2337', '\u20bd', '\u03a1', '\u2501', '\u25f6', '\u03bc', '\u259b', '\u2588', ...]`\r\n\r\n</details>\r\n\r\n<details>\r\n <summary><b><code> cool_pixel_samples </code></b></summary> \r\n<i><br> A curated list of Unicode symbols that are visually appealing and work well as pixel characters.</i>\r\n\r\n```python\r\n\r\nimport pixel_pretender as pxp \r\n\r\n# Display a selection of recommended symbols for pixelated text.\r\nprint(pxp.cool_pixel_samples)\r\n```\r\n- ***result:***\r\n`['\u2573', '\u2572', '\u2571', '\u256e', '\u2575', '\u2584', '\u2585', '\u2586', '\u2587', '\u2588', '\u2589', '\u259d', '\u259a', '\u2596', '\u2593', '\u2592', '\u2591', '\u2590', '\u25a1', '\u25aa', '\u25a0', '\u259f','\u25c6', '\u25c7', '\u25c9', '\u25cb', '\u25ce', '\u25cf', ...]`\r\n</details> \r\n\r\n## Need Help with a Specific Function?\r\n\r\n- **To get detailed information on any function, use Python's built-in `help()` function on the function name.**\r\n - **For example:**\r\n\r\n```python\r\nimport pixel_pretender as pxp\r\n\r\nhelp(pxp.apply_colorama_color)\r\n```\r\n- - **result:**\r\n```\r\nHelp on function apply_colorama_color in module pixel_pretender:\r\n\r\napply_colorama_color(pixel_list, color)\r\n Applies a specified text color to a list of pixel strings using Colorama.\r\n \r\n Parameters:\r\n - pixel_list (list of str): A list of pixel strings to color.\r\n - color (str): A color name that specifies the text color to be applied. (e.g., \"red\", \"blue\", \"light green\").\r\n - A tuple containing all available color names from the colorama library is stored in colorama_colors\r\n \r\n Returns:\r\n - list of str: A new list of pixel strings with the specified text color applied to the first\r\n line and a reset applied to the last line.\r\n \r\n Raises:\r\n - TypeError: If pixel_list is not a list of strings or if color is not a string.\r\n - ValueError: If color is not in colorama_colors.\r\n\r\n```\r\n\r\n## Notes\r\n- Unicode* :\r\n - **Some Unicode symbols may not display correctly due to varying spacing compared to ASCII letters**\r\n- Rich Library :\r\n - **PyCharm users should enable the \u201cEmulate terminal in output console\u201d option in the run/debug configuration, or run the program in the terminal to view the styled output.**\r\n\r\n## Contributing\r\n\r\n**This project is maintained as time and resources permit, However, the community is encouraged to contribute, fork, and modify the code freely. Contributions are always welcome and appreciated.**\r\n\r\n***You are encouraged to:***\r\n- Submit pull requests for bug fixes or feature enhancements. \r\n- Fork the repository and adapt it to suit your needs. \r\n\r\nThere are no strict guidelines or requirements for contributing,\r\nthis project is now a collaborative effort for the benefit of the community. ***However, please note that approving pull requests may take some time.***\r\n\r\n### Publishing to PyPI\r\nThis project is published on PyPI as `pixel_pretender`. If you contribute a significant feature and would like to publish it, please request to be added as a maintainer on PyPI by opening an issue. Alternatively, feel free to fork this project and publish your version independently.\r\n\r\n## Author\r\nCreated by [Anasse Gassab](https://github.com/AnasseGX).\r\n\r\n## Licenses\r\n- **Pixel_Pretender** is licensed under the MIT License - see the [LICENSE](https://github.com/AnasseGX/Pixel_pretender/blob/master/LICENSE%20.txt) file for details.\r\n\r\n\r\n- **Colorama** is licensed under the BSD license. See [Colorama License](https://github.com/tartley/colorama/blob/master/LICENSE.txt) for details.\r\n- **Rich** is licensed under the MIT license. See [Rich License](https://github.com/Textualize/rich/blob/master/LICENSE) for details.\r\n\r\n## Acknowledgements\r\n- This project uses the [Colorama](https://pypi.org/project/colorama/) library for basic terminal color support.\r\n- This project uses the [Rich](https://pypi.org/project/rich/) library for advanced text formatting and styling in the terminal.\r\n\r\n- ***Thanks to the Python community for the awesome libraries like `colorama` and `rich`.***\r\n- Inspired by Seven Segment Displays, ASCII art and creative console designs.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Render pixelated text in the console using customizable symbols and colors.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/AnasseGX/Pixel_pretender"
},
"split_keywords": [
"ascii",
"unicode",
"pixel",
"art",
"terminal",
"text",
"rendering",
"color",
"formatting"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a4a84e72aec3274d2e15ec1c7f40025e52bd8fae6b18d8e296a978a4dd5d288b",
"md5": "fa02981b795d8cf21b8dc4bb4a0bb02a",
"sha256": "3d59bef986d13533caa142cee438c183397771570c95a17ed4e9b9ef1beaeeb1"
},
"downloads": -1,
"filename": "pixel_pretender-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa02981b795d8cf21b8dc4bb4a0bb02a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 16238,
"upload_time": "2024-11-23T16:51:53",
"upload_time_iso_8601": "2024-11-23T16:51:53.010586Z",
"url": "https://files.pythonhosted.org/packages/a4/a8/4e72aec3274d2e15ec1c7f40025e52bd8fae6b18d8e296a978a4dd5d288b/pixel_pretender-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3244c5e1a078f0bb731ccdfef807bb902824eeb4ef9d913c104a80755d019575",
"md5": "31ff030a4cbc6a7c0c0ae950526d1eb2",
"sha256": "ede96c2d7f23361104a9000c4c0041a737e57331f568a48198c7c974340a355b"
},
"downloads": -1,
"filename": "pixel_pretender-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "31ff030a4cbc6a7c0c0ae950526d1eb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 25227,
"upload_time": "2024-11-23T16:51:55",
"upload_time_iso_8601": "2024-11-23T16:51:55.217224Z",
"url": "https://files.pythonhosted.org/packages/32/44/c5e1a078f0bb731ccdfef807bb902824eeb4ef9d913c104a80755d019575/pixel_pretender-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 16:51:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnasseGX",
"github_project": "Pixel_pretender",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pixel-pretender"
}
JSON
