textfmt 0.1.0__py3-none-any.whl

textfmt-0.1.0.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: textfmt
+Version: 0.1.0
+Summary: A Python module for ANSI text formatting, word art, and table styling
+Author-email: Rihaan Meher <meherrihaan@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/sharktide/textformat
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# textfmt
+
+A lightweight Python module for ANSI text formatting, customizable word art, and table rendering in CLI applications.
+
+## Features
+- **ANSI Colors & Styles** – Easily format text using intuitive color mappings.
+- **Customizable Word Art** – Generate banners with adjustable characters and widths.
+- **Table Formatting** – Display structured data in a clean, readable format.
+
+## Installation
+Install via PyPI:
+```sh
+pip install textformat
+```
+
+## Usage
+
+Basic Text Formatting
+
+```python
+import textfmt
+
+print(textfmt.TextFmt.style("Hello, World!", textfmt.TextFmt.BOLD, textfmt.TextFmt.COLORS["blue"]))
+```
+
+Custom Word Art Banner
+```python
+import textfmt.word_art
+
+print(textfmt.word_art.WordArt.banner("TEXTFMT", char="*", width=40))
+```
+
+Table Rendering
+```python
+import textfmt.table
+
+headers = ["Name", "Color", "Effect"]
+data = [
+    ["Bold", "White", "Strong emphasis"],
+    ["Underline", "Blue", "Text decoration"],
+    ["Warning", "Yellow", "Cautionary message"],
+]
+
+print(textfmt.table.TableFormatter.generate(headers, data))
+```
+## License
+MIT License – Free to use and modify.

textfmt-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+textformat/__init__.py,sha256=OeDcG1aKyzES1aLCdjxC06NYtNBDRMrqnGVO7KDW1pc,182
+textformat/table.py,sha256=GA7MsMWNuug61XxK9Ot3SOg5bl9zh5GO9Hae8-Y2qeE,604
+textformat/textformat.py,sha256=hRfVOZqQCT8955F9qj8_rFPPn0tZxtOpogRtkxZ7BL8,859
+textformat/word_art.py,sha256=GsJka0ukV23FTvhuyuGRChhNGOjTWOdKBK3h0e-LnX8,318
+textfmt-0.1.0.dist-info/METADATA,sha256=ojispDnWgHDPog7otaNGULpybth0GFLuFUM2qKRW7Hw,1486
+textfmt-0.1.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+textfmt-0.1.0.dist-info/top_level.txt,sha256=Nf6G1sI6EqA2opfIdIio6ZqKNbpT2EtYf5cd0sKgPRo,11
+textfmt-0.1.0.dist-info/RECORD,,

textfmt-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

textfmt-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+textformat

textformat/__init__.py

@@ -0,0 +1,6 @@
+# textfmt/__init__.py
+from .textformat import TextFormat
+from .word_art import WordArt
+from .table import TableFormatter
+
+__all__ = ["TextFormat", "WordArt", "TableFormatter"]

textformat/table.py

@@ -0,0 +1,13 @@
+class TableFormatter:
+    """ Formats tables for CLI display """
+
+    @staticmethod
+    def generate(headers, data):
+        """ Creates a formatted table for structured output """
+        col_widths = [max(len(str(item)) for item in col) for col in zip(headers, *data)]
+        border = "+".join("-" * (w + 2) for w in col_widths)
+
+        def format_row(row):
+            return "| " + " | ".join(f"{str(item).ljust(w)}" for item, w in zip(row, col_widths)) + " |"
+
+        return f"{border}\n{format_row(headers)}\n{border}\n" + "\n".join(format_row(row) for row in data) + f"\n{border}"

textformat/textformat.py

@@ -0,0 +1,24 @@
+class TextFormat:
+    """ ANSI Escape Code Formatting for Python CLI Output """
+    RESET = "\x1b[0m"
+
+    BOLD = "\x1b[1m"  # Basic bold without a color
+
+    UNDERLINE = "\x1b[4m"  # Add this line for underline support
+
+    COLORS = {
+        "black": "\x1b[30m", "blue": "\x1b[34m", "cyan": "\x1b[36m",
+        "green": "\x1b[32m", "grey": "\x1b[90m", "magenta": "\x1b[35m",
+        "red": "\x1b[31m", "white": "\x1b[37m", "yellow": "\x1b[33m"
+    }
+
+    BOLD_COLORS = {
+        "black": "\x1b[1;30m", "blue": "\x1b[1;34m", "cyan": "\x1b[1;36m",
+        "green": "\x1b[1;32m", "magenta": "\x1b[1;35m", "red": "\x1b[1;31m",
+        "white": "\x1b[1;37m", "yellow": "\x1b[1;33m"
+    }
+
+    @staticmethod
+    def style(text, *styles):
+        """ Applies ANSI styles to text """
+        return "".join(styles) + text + TextFormat.RESET

textformat/word_art.py

@@ -0,0 +1,9 @@
+class WordArt:
+    """ Generates customizable word art banners """
+
+    @staticmethod
+    def banner(text, char="█", width=50):
+        """ Creates a formatted word art banner """
+        top = char * width
+        middle = f"{char} {text.center(width - 4)} {char}"
+        return f"{top}\n{middle}\n{top}"