colrs 0.1.0__tar.gz

colrs-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: colrs
+Version: 0.1.0
+Summary: A simple and elegant Python library for terminal text coloring.
+Home-page: https://github.com/kalth/colrs
+Author: hussain_syrer
+Author-email: h2311065@gmail.com
+Keywords: color terminal ansi text style coloring cli print input
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: colorama
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# colorara 🎨
+
+A simple, elegant, and easy-to-use Python library to add color to your terminal text and backgrounds.
+
+## Features
+
+- **Simple API:** Color your text with zero hassle.
+- **Cross-Platform:** Works on Windows, macOS, and Linux thanks to `colorama`.
+- **Inline Tag Coloring:** Color specific words within a string using simple tags like `<green>word</>`.
+- **Colored User Input:** Control the color of the user's typed text in `input()` prompts.
+- **"Magic":** An optional mode to make the built-in `print()` and `input()` color-aware.
+- **Lightweight:** Has only one dependency (`colorama`) for cross-platform support.
+
+## Installation
+
+First, navigate to the `colorara` project directory. Then, install it using `pip`:
+
+```bash
+pip install .
+```
+After installation, you can import it in any Python script on your system.
+
+## Usage
+
+`colorara` is designed for flexibility and ease of use.
+
+---
+
+### `cprint()` and Inline Coloring
+
+The `cprint()` function is your main tool for printing. It supports both coloring the entire line and coloring specific parts of a string using tags.
+
+**Syntax:** `<color_name>text</>` or `<text_color,bg_color>text</>`
+
+```python
+from colorara import cprint
+
+# Overall coloring (like before)
+cprint("This entire line is green.", color="green")
+
+# --- Inline Tag Coloring ---
+# Color a specific word
+cprint("Status: <green>OK</>")
+
+# Use multiple colors in one line
+cprint("Results: <green>SUCCESS</>, Warnings: <yellow>3</>, Errors: <red>0</>")
+
+# You can also color backgrounds
+cprint("System State: <white,bg_green>ONLINE</>") 
+cprint("Alert: <black,bg_yellow>CHECK CONFIG</>")
+
+# If you provide a `color` argument with tags, it is ignored
+cprint("The tag <green>always</> wins.", color="red") # "always" will be green
+```
+
+### `cinput()` and Colored User Input
+
+Use `cinput()` to get user input with a colored prompt and even colored user-typed text.
+
+It accepts a new argument `inp_color`. If you provide it, the user's typing will be in that color. If you don't, the user's typing will have the same color as the prompt.
+
+```python
+from colorara import cinput
+
+# The user's typed text will be cyan, just like the prompt
+name = cinput("Enter your name: ", color="cyan")
+print(f"Hello, {name}!")
+
+# The prompt will be yellow, but the user's typing will be blue
+age = cinput("Enter your age: ", color="yellow", inp_color="blue")
+print(f"You are {age} years old.")
+```
+
+---
+
+### Magic ✨
+
+This mode is for maximum convenience. By calling `magic()` once, `colorara` patches the built-in `print()` and `input()` functions, giving them all the powers of `cprint` and `cinput`.
+
+**⚠️ Warning:** This modifies Python's built-in functions and might cause conflicts if another library tries to do the same. Use it with caution.
+
+```python
+from colorara import magic, revert
+
+# Activate magic
+magic()
+
+# The built-in print now understands tags!
+print("Magic <magenta>print</> supports tags too!")
+print("Status: <green>OK</>, Mode: <cyan,bg_black>MAGIC</>")
+
+# The magic input also supports `inp_color`
+food = input("Favorite food (prompt is red, typing is green)? ", color="red", inp_color="green")
+print(f"You like {food}!")
+
+# You can revert the changes if needed
+revert()
+
+# This print will be normal again
+print("Back to normal.")
+```
+
+## Available Colors
+
+You can use the following color names for both `color` and `bg_color`:
+
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue`
+- `magenta`
+- `cyan`
+- `white`

colrs-0.1.0/README.md

@@ -0,0 +1,114 @@
+# colorara 🎨
+
+A simple, elegant, and easy-to-use Python library to add color to your terminal text and backgrounds.
+
+## Features
+
+- **Simple API:** Color your text with zero hassle.
+- **Cross-Platform:** Works on Windows, macOS, and Linux thanks to `colorama`.
+- **Inline Tag Coloring:** Color specific words within a string using simple tags like `<green>word</>`.
+- **Colored User Input:** Control the color of the user's typed text in `input()` prompts.
+- **"Magic":** An optional mode to make the built-in `print()` and `input()` color-aware.
+- **Lightweight:** Has only one dependency (`colorama`) for cross-platform support.
+
+## Installation
+
+First, navigate to the `colorara` project directory. Then, install it using `pip`:
+
+```bash
+pip install .
+```
+After installation, you can import it in any Python script on your system.
+
+## Usage
+
+`colorara` is designed for flexibility and ease of use.
+
+---
+
+### `cprint()` and Inline Coloring
+
+The `cprint()` function is your main tool for printing. It supports both coloring the entire line and coloring specific parts of a string using tags.
+
+**Syntax:** `<color_name>text</>` or `<text_color,bg_color>text</>`
+
+```python
+from colorara import cprint
+
+# Overall coloring (like before)
+cprint("This entire line is green.", color="green")
+
+# --- Inline Tag Coloring ---
+# Color a specific word
+cprint("Status: <green>OK</>")
+
+# Use multiple colors in one line
+cprint("Results: <green>SUCCESS</>, Warnings: <yellow>3</>, Errors: <red>0</>")
+
+# You can also color backgrounds
+cprint("System State: <white,bg_green>ONLINE</>") 
+cprint("Alert: <black,bg_yellow>CHECK CONFIG</>")
+
+# If you provide a `color` argument with tags, it is ignored
+cprint("The tag <green>always</> wins.", color="red") # "always" will be green
+```
+
+### `cinput()` and Colored User Input
+
+Use `cinput()` to get user input with a colored prompt and even colored user-typed text.
+
+It accepts a new argument `inp_color`. If you provide it, the user's typing will be in that color. If you don't, the user's typing will have the same color as the prompt.
+
+```python
+from colorara import cinput
+
+# The user's typed text will be cyan, just like the prompt
+name = cinput("Enter your name: ", color="cyan")
+print(f"Hello, {name}!")
+
+# The prompt will be yellow, but the user's typing will be blue
+age = cinput("Enter your age: ", color="yellow", inp_color="blue")
+print(f"You are {age} years old.")
+```
+
+---
+
+### Magic ✨
+
+This mode is for maximum convenience. By calling `magic()` once, `colorara` patches the built-in `print()` and `input()` functions, giving them all the powers of `cprint` and `cinput`.
+
+**⚠️ Warning:** This modifies Python's built-in functions and might cause conflicts if another library tries to do the same. Use it with caution.
+
+```python
+from colorara import magic, revert
+
+# Activate magic
+magic()
+
+# The built-in print now understands tags!
+print("Magic <magenta>print</> supports tags too!")
+print("Status: <green>OK</>, Mode: <cyan,bg_black>MAGIC</>")
+
+# The magic input also supports `inp_color`
+food = input("Favorite food (prompt is red, typing is green)? ", color="red", inp_color="green")
+print(f"You like {food}!")
+
+# You can revert the changes if needed
+revert()
+
+# This print will be normal again
+print("Back to normal.")
+```
+
+## Available Colors
+
+You can use the following color names for both `color` and `bg_color`:
+
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue`
+- `magenta`
+- `cyan`
+- `white`

colrs-0.1.0/colrs/__init__.py

@@ -0,0 +1,22 @@
+# colorara/colorara/__init__.py
+
+"""
+colorara - A simple and elegant way to color your terminal text.
+"""
+
+__version__ = "0.1.0"
+
+# Initialize colorama to make ANSI codes work on Windows and to auto-reset colors.
+from colorama import init
+init(autoreset=True)
+
+from .core import cprint, cinput, colorize
+from .magic import magic, revert
+
+__all__ = [
+    'cprint',
+    'cinput',
+    'colorize',
+    'magic',
+    'revert'
+]

colrs-0.1.0/colrs/core.py

@@ -0,0 +1,116 @@
+# colorara/colorara/core.py
+
+import builtins
+import re
+
+# ANSI escape codes
+COLORS = {
+    "black": "\033[30m",
+    "red": "\033[31m",
+    "green": "\033[32m",
+    "yellow": "\033[33m",
+    "blue": "\033[34m",
+    "magenta": "\033[35m",
+    "cyan": "\033[36m",
+    "white": "\033[37m",
+    "reset": "\033[0m",
+}
+
+BG_COLORS = {
+    "black": "\033[40m",
+    "red": "\033[41m",
+    "green": "\033[42m",
+    "yellow": "\033[43m",
+    "blue": "\033[44m",
+    "magenta": "\033[45m",
+    "cyan": "\033[46m",
+    "white": "\033[47m",
+}
+
+def colorize(text: str, color: str = None, bg_color: str = None) -> str:
+    """
+    Wraps text with ANSI color codes.
+    """
+    if not isinstance(text, str):
+        text = str(text)
+        
+    color_code = COLORS.get(str(color).lower()) if color else ""
+    bg_color_code = BG_COLORS.get(str(bg_color).lower()) if bg_color else ""
+
+    if color_code or bg_color_code:
+        return f"{bg_color_code}{color_code}{text}{COLORS['reset']}"
+    
+    return text
+
+def _process_text_for_printing(text: str, color: str = None, bg_color: str = None) -> str:
+    """
+    Processes a string for printing, handling both inline color tags and
+    overall coloring. If tags are found, they take precedence.
+    """
+    # Regex to find color tags like <green> or <white,bg_blue>
+    tag_regex = r"<([a-zA-Z0-9_,]+)>(.*?)</>"
+
+    if "<" not in text and "</>" not in text:
+        return colorize(text, color, bg_color)
+
+    def replacer(match):
+        tags = match.group(1).lower().split(',')
+        inner_text = match.group(2)
+        
+        tag_color = None
+        tag_bg_color = None
+        
+        for tag in tags:
+            if tag.startswith('bg_'):
+                tag_bg_color = tag[3:]
+            else:
+                tag_color = tag
+                
+        return colorize(inner_text, tag_color, tag_bg_color)
+
+    # Apply default color to the whole string first, then parse tags
+    # This is complex. Let's just color the untagged parts.
+    # A simpler approach for now: tags override the main color.
+    return re.sub(tag_regex, replacer, text)
+
+
+def cprint(*args, color: str = None, bg_color: str = None, **kwargs):
+    """
+    A safe wrapper around the built-in print function that adds color,
+    supporting both overall coloring and inline color tags.
+    
+    e.g. cprint("Status: <green>OK</>")
+    """
+    text = " ".join(map(str, args))
+    processed_text = _process_text_for_printing(text, color, bg_color)
+    builtins.print(processed_text, **kwargs)
+
+def _get_colored_input_prompt(prompt: str, color: str, bg_color: str, inp_color: str) -> str:
+    """
+    Internal helper to construct the final prompt string for input,
+    handling both prompt color and user input color.
+    """
+    # If inp_color is not given, it defaults to the prompt's text color
+    effective_inp_color = inp_color if inp_color is not None else color
+
+    # Color the prompt part (which includes a reset)
+    colored_prompt = colorize(prompt, color, bg_color)
+
+    # Get the color code for the user's input, or an empty string if no color
+    input_color_code = COLORS.get(str(effective_inp_color).lower(), "") if effective_inp_color else ""
+    
+    # The final prompt string sets the color for the user's typing
+    return colored_prompt + input_color_code
+
+def cinput(prompt: str = "", color: str = None, bg_color: str = None, inp_color: str = None) -> str:
+    """
+    A safe wrapper around the built-in input function that adds color to the
+    prompt and optionally to the user's typed input.
+
+    :param prompt: The prompt string to display.
+    :param color: The color of the prompt string.
+    :param bg_color: The background color of the prompt string.
+    :param inp_color: The color of the user's typed text. If None, defaults to `color`.
+    """
+    final_prompt = _get_colored_input_prompt(prompt, color, bg_color, inp_color)
+    return builtins.input(final_prompt)

colrs-0.1.0/colrs/magic.py

@@ -0,0 +1,64 @@
+# colorara/colorara/magic.py
+
+import builtins
+from .core import cprint, _get_colored_input_prompt, _process_text_for_printing
+
+_original_print = builtins.print
+_original_input = builtins.input
+
+def _magic_print(*args, **kwargs):
+    """
+    A patched version of print that handles color arguments, including
+    inline color tags.
+    """
+    # Extract our custom color arguments, removing them from kwargs
+    color = kwargs.pop("color", None)
+    bg_color = kwargs.pop("bg_color", None)
+    
+    text = " ".join(map(str, args))
+    processed_text = _process_text_for_printing(text, color, bg_color)
+    
+    _original_print(processed_text, **kwargs)
+
+def _magic_input(prompt: str = "", **kwargs) -> str:
+    """
+    A patched version of input that handles color arguments for the prompt
+    and for the user's typed input.
+    """
+    # Extract our custom color arguments from kwargs
+    color = kwargs.get("color")
+    bg_color = kwargs.get("bg_color")
+    inp_color = kwargs.get("inp_color")
+    
+    final_prompt = _get_colored_input_prompt(prompt, color, bg_color, inp_color)
+    return _original_input(final_prompt)
+
+def magic():
+    """
+    Activates 'Magic Mode' by patching the built-in print and input functions.
+    
+    This allows you to use 'color' and 'bg_color' arguments directly in print()
+    and input() without calling a special function.
+    
+    Warning: This modifies built-in functions and may conflict with other
+    libraries that also modify them. Use with caution.
+    """
+    if builtins.print == _magic_print:
+        cprint("Magic is already active.", color="yellow")
+        return
+
+    builtins.print = _magic_print
+    builtins.input = _magic_input
+    cprint("Magic activated. `print` and `input` are now color-aware.", color="yellow")
+
+def revert():
+    """
+    Deactivates 'Magic' and restores the original built-in functions.
+    """
+    if builtins.print != _magic_print:
+        cprint("Magic is not active.", color="yellow")
+        return
+        
+    builtins.print = _original_print
+    builtins.input = _original_input
+    cprint("Magic deactivated. `print` and `input` restored.", color="yellow")

colrs-0.1.0/colrs.egg-info/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: colrs
+Version: 0.1.0
+Summary: A simple and elegant Python library for terminal text coloring.
+Home-page: https://github.com/kalth/colrs
+Author: hussain_syrer
+Author-email: h2311065@gmail.com
+Keywords: color terminal ansi text style coloring cli print input
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: colorama
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# colorara 🎨
+
+A simple, elegant, and easy-to-use Python library to add color to your terminal text and backgrounds.
+
+## Features
+
+- **Simple API:** Color your text with zero hassle.
+- **Cross-Platform:** Works on Windows, macOS, and Linux thanks to `colorama`.
+- **Inline Tag Coloring:** Color specific words within a string using simple tags like `<green>word</>`.
+- **Colored User Input:** Control the color of the user's typed text in `input()` prompts.
+- **"Magic":** An optional mode to make the built-in `print()` and `input()` color-aware.
+- **Lightweight:** Has only one dependency (`colorama`) for cross-platform support.
+
+## Installation
+
+First, navigate to the `colorara` project directory. Then, install it using `pip`:
+
+```bash
+pip install .
+```
+After installation, you can import it in any Python script on your system.
+
+## Usage
+
+`colorara` is designed for flexibility and ease of use.
+
+---
+
+### `cprint()` and Inline Coloring
+
+The `cprint()` function is your main tool for printing. It supports both coloring the entire line and coloring specific parts of a string using tags.
+
+**Syntax:** `<color_name>text</>` or `<text_color,bg_color>text</>`
+
+```python
+from colorara import cprint
+
+# Overall coloring (like before)
+cprint("This entire line is green.", color="green")
+
+# --- Inline Tag Coloring ---
+# Color a specific word
+cprint("Status: <green>OK</>")
+
+# Use multiple colors in one line
+cprint("Results: <green>SUCCESS</>, Warnings: <yellow>3</>, Errors: <red>0</>")
+
+# You can also color backgrounds
+cprint("System State: <white,bg_green>ONLINE</>") 
+cprint("Alert: <black,bg_yellow>CHECK CONFIG</>")
+
+# If you provide a `color` argument with tags, it is ignored
+cprint("The tag <green>always</> wins.", color="red") # "always" will be green
+```
+
+### `cinput()` and Colored User Input
+
+Use `cinput()` to get user input with a colored prompt and even colored user-typed text.
+
+It accepts a new argument `inp_color`. If you provide it, the user's typing will be in that color. If you don't, the user's typing will have the same color as the prompt.
+
+```python
+from colorara import cinput
+
+# The user's typed text will be cyan, just like the prompt
+name = cinput("Enter your name: ", color="cyan")
+print(f"Hello, {name}!")
+
+# The prompt will be yellow, but the user's typing will be blue
+age = cinput("Enter your age: ", color="yellow", inp_color="blue")
+print(f"You are {age} years old.")
+```
+
+---
+
+### Magic ✨
+
+This mode is for maximum convenience. By calling `magic()` once, `colorara` patches the built-in `print()` and `input()` functions, giving them all the powers of `cprint` and `cinput`.
+
+**⚠️ Warning:** This modifies Python's built-in functions and might cause conflicts if another library tries to do the same. Use it with caution.
+
+```python
+from colorara import magic, revert
+
+# Activate magic
+magic()
+
+# The built-in print now understands tags!
+print("Magic <magenta>print</> supports tags too!")
+print("Status: <green>OK</>, Mode: <cyan,bg_black>MAGIC</>")
+
+# The magic input also supports `inp_color`
+food = input("Favorite food (prompt is red, typing is green)? ", color="red", inp_color="green")
+print(f"You like {food}!")
+
+# You can revert the changes if needed
+revert()
+
+# This print will be normal again
+print("Back to normal.")
+```
+
+## Available Colors
+
+You can use the following color names for both `color` and `bg_color`:
+
+- `black`
+- `red`
+- `green`
+- `yellow`
+- `blue`
+- `magenta`
+- `cyan`
+- `white`

colrs-0.1.0/colrs.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+setup.py
+colrs/__init__.py
+colrs/core.py
+colrs/magic.py
+colrs.egg-info/PKG-INFO
+colrs.egg-info/SOURCES.txt
+colrs.egg-info/dependency_links.txt
+colrs.egg-info/requires.txt
+colrs.egg-info/top_level.txt

colrs-0.1.0/colrs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

colrs-0.1.0/colrs.egg-info/requires.txt

@@ -0,0 +1 @@
+colorama

colrs-0.1.0/colrs.egg-info/top_level.txt

@@ -0,0 +1 @@
+colrs

colrs-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

colrs-0.1.0/setup.py

@@ -0,0 +1,38 @@
+# colorara/setup.py
+
+from setuptools import setup, find_packages
+
+# Read the contents of your README file
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name='colrs',
+    version='0.1.0',
+    author='hussain_syrer',
+    author_email='h2311065@gmail.com',
+    description='A simple and elegant Python library for terminal text coloring.',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/kalth/colrs', # Placeholder URL
+    packages=find_packages(),
+    install_requires=[
+        'colorama',
+    ],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Operating System :: OS Independent',
+        'Topic :: Terminals',
+        'Topic :: Utilities',
+    ],
+    python_requires='>=3.7',
+    keywords='color terminal ansi text style coloring cli print input',
+)