byteforge-figlet 2.0.4__py3-none-any.whl

byteforge_figlet/layout_mode.py

@@ -0,0 +1,18 @@
+"""Layout mode enumeration for FIGLet rendering."""
+
+from enum import IntEnum
+
+
+class LayoutMode(IntEnum):
+    """Controls how FIGLet characters are horizontally arranged."""
+
+    FullSize = -1
+    """Characters are placed side by side with no overlap."""
+
+    Kerning = 0
+    """Characters are moved as close together as possible without overlapping."""
+
+    Smushing = 1
+    """Characters may overlap and be merged according to smushing rules."""
+
+    Default = 1  # alias for Smushing

byteforge_figlet/smushing_rules.py

@@ -0,0 +1,32 @@
+"""Smushing rules flags for FIGLet rendering."""
+
+from enum import IntFlag
+
+
+class SmushingRules(IntFlag):
+    """Flags that control which smushing rules are applied during rendering."""
+
+    NONE = 0
+    """No smushing rules apply."""
+
+    EqualCharacter = 1
+    """Rule 1: Two identical characters smush into one."""
+
+    Underscore = 2
+    """Rule 2: An underscore is replaced by any character in the hierarchy."""
+
+    Hierarchy = 4
+    """Rule 3: A character of higher hierarchy replaces one of lower hierarchy."""
+
+    OppositePair = 8
+    """Rule 4: Opposing brackets/braces/parens smush into a vertical bar."""
+
+    BigX = 16
+    """Rule 5: /+\\ becomes |, \\+/ becomes Y, >+< becomes X."""
+
+    HardBlank = 32
+    """Rule 6: Two hardblanks smush into one hardblank."""
+
+    def has_rule(self, rule: "SmushingRules") -> bool:
+        """Return True if this set of rules includes the given rule."""
+        return bool(self & rule)

byteforge_figlet-2.0.4.dist-info/METADATA

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: byteforge-figlet
+Version: 2.0.4
+Summary: Python FIGLet rendering library — render text as ASCII art using .flf fonts
+Project-URL: Homepage, https://github.com/PaulStSmith/figlet-comment-generator
+Project-URL: Repository, https://github.com/PaulStSmith/figlet-comment-generator
+Project-URL: Issues, https://github.com/PaulStSmith/figlet-comment-generator/issues
+Author-email: PaulStSmith <paul@byteforge.dev>
+License: MIT
+License-File: LICENSE
+Keywords: ascii-art,cli,figlet,fonts,text-art
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Terminals
+Classifier: Topic :: Text Processing :: Fonts
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# 🐍 **BYTEFORGE FIGLET SUITE — byteforge-figlet (Python Library)**
+
+```
+██████╗ ██╗   ██╗████████╗███████╗███████╗ ██████╗ ██████╗  ██████╗ ███████╗
+██╔══██╗╚██╗ ██╔╝╚══██╔══╝██╔════╝██╔════╝██╔═══██╗██╔══██╗██╔════╝ ██╔════╝
+██████╔╝ ╚████╔╝    ██║   █████╗  █████╗  ██║   ██║██████╔╝██║  ███╗█████╗
+██╔══██╗  ╚██╔╝     ██║   ██╔══╝  ██╔══╝  ██║   ██║██╔══██╗██║   ██║██╔══╝
+██████╔╝   ██║      ██║   ███████╗██║     ╚██████╔╝██║  ██║╚██████╔╝███████╗
+╚═════╝    ╚═╝      ╚═╝   ╚══════╝╚═╝      ╚═════╝ ╚═╝  ╚═╝ ╚═════╝ ╚══════╝
+                 ███████╗██╗ ██████╗ ██╗     ███████╗████████╗    ███████╗██╗   ██╗██╗████████╗███████╗
+                 ██╔════╝██║██╔════╝ ██║     ██╔════╝╚══██╔══╝    ██╔════╝██║   ██║██║╚══██╔══╝██╔════╝
+                 █████╗  ██║██║  ███╗██║     █████╗     ██║       ███████╗██║   ██║██║   ██║   █████╗
+                 ██╔══╝  ██║██║   ██║██║     ██╔══╝     ██║       ╚════██║██║   ██║██║   ██║   ██╔══╝
+                 ██║     ██║╚██████╔╝███████╗███████╗   ██║       ███████║╚██████╔╝██║   ██║   ███████╗
+                 ╚═╝     ╚═╝ ╚═════╝ ╚══════╝╚══════╝   ╚═╝       ╚══════╝ ╚═════╝ ╚═╝   ╚═╝   ╚══════╝
+```
+
+> **byteforge-figlet**
+> *A fast, spec-compliant FIGLet engine for Python — zero dependencies.*
+
+## 📘 Overview
+
+`byteforge-figlet` is a Python implementation of the FIGLet rendering engine used across the ByteForge FIGLet Suite.
+
+It provides a robust and efficient implementation of the FIGLet specification, allowing you to create ASCII art from text using FIGLet fonts. It supports all standard FIGLet features including various smushing rules, layout modes, ANSI color preservation, and Unicode.
+
+The library ships with the built-in **small** font so it works out of the box with no additional downloads.
+
+## ✨ Features
+
+- 🔤 Render FIGLet text using any `.flf` font
+- 📄 Full FIGLet font (`.flf`) file parsing and loading
+- 🗜️ Automatic handling of compressed/zipped font files
+- 🎨 ANSI color support for terminal output
+- 🌏 Unicode support
+- 📝 Paragraph formatting support
+- ⚙️ Supports Full Size, Kerning, and Smushing layout modes
+- 🧠 Implements all official smushing rules
+- 📦 Default embedded font included — works out of the box
+- 🚀 Zero dependencies — stdlib only
+- 🐍 Python 3.9+
+- 💻 Includes a `figprint` CLI command
+
+### Sample Output
+
+```
+  _  _     _ _          _        _       _    _ _
+ | || |___| | |___      \ \    / /__ _ _| |__| | |
+ | __ / -_) | / _ \_     \ \/\/ / _ \ '_| / _` |_|
+ |_||_\___|_|_\___( )     \_/\_/\___/_| |_\__,_(_)
+                  |/
+```
+
+## 🛠 Installation
+
+Install via pip:
+
+```bash
+pip install byteforge-figlet
+```
+
+## 🚀 Quick Start
+
+### Basic Usage
+
+```python
+from byteforge_figlet import FIGLetRenderer
+
+print(FIGLetRenderer.render("Hello World!"))
+```
+
+### Using a Custom Font
+
+```python
+from byteforge_figlet import FIGFont, FIGLetRenderer
+
+font = FIGFont.from_file("/path/to/myfont.flf")
+print(FIGLetRenderer.render("Hello!", font=font))
+```
+
+### Choosing a Layout Mode
+
+```python
+from byteforge_figlet import FIGLetRenderer, LayoutMode
+
+# Full Size — no character overlap
+print(FIGLetRenderer.render("Hi", mode=LayoutMode.FullSize))
+
+# Kerning — characters touch but don't overlap
+print(FIGLetRenderer.render("Hi", mode=LayoutMode.Kerning))
+
+# Smushing — characters may merge (default)
+print(FIGLetRenderer.render("Hi", mode=LayoutMode.Smushing))
+```
+
+### Renderer Instance
+
+```python
+from byteforge_figlet import FIGLetRenderer, LayoutMode
+
+renderer = FIGLetRenderer(mode=LayoutMode.Kerning, line_separator="\n")
+print(renderer.render_text("Hello\nWorld"))
+```
+
+## 💻 CLI Usage
+
+The `figprint` command is installed automatically with the package:
+
+```bash
+figprint "Hello World"
+figprint "Hello World" --font /path/to/font.flf
+figprint "Hello World" --mode kerning
+figprint "Hello World" --mode full
+figprint --help
+```
+
+Or run as a module:
+
+```bash
+python -m byteforge_figlet "Hello World"
+```
+
+## 📐 API Reference
+
+### `FIGFont`
+
+| Method / Property | Description |
+|---|---|
+| `FIGFont.default` | The built-in `small` font (class property, cached) |
+| `FIGFont.from_file(path)` | Load a font from a `.flf` file path |
+| `FIGFont.from_stream(stream)` | Load a font from a binary stream |
+| `FIGFont.from_text(text)` | Load a font from a string |
+| `FIGFont.from_lines(lines)` | Load a font from a list of strings |
+| `.height` | Character height in rows |
+| `.hard_blank` | Hard blank character |
+| `.smushing_rules` | `SmushingRules` flags for this font |
+| `.has_smushing_rule(rule)` | Check if a specific rule is set |
+
+### `FIGLetRenderer`
+
+| Method | Description |
+|---|---|
+| `FIGLetRenderer.render(text, ...)` | Static method — render and return ASCII art string |
+| `renderer.render_text(text)` | Instance method — render using configured settings |
+
+**Constructor parameters:**
+
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `font` | `FIGFont \| None` | built-in small | Font to use |
+| `mode` | `LayoutMode` | `Smushing` | Layout mode |
+| `line_separator` | `str \| None` | `os.linesep` | Line ending |
+| `use_ansi_colors` | `bool` | `False` | Preserve ANSI color codes |
+| `paragraph_mode` | `bool` | `True` | Treat `\n` as paragraph breaks |
+
+### `LayoutMode`
+
+| Value | Description |
+|---|---|
+| `LayoutMode.FullSize` (`-1`) | No character overlap |
+| `LayoutMode.Kerning` (`0`) | Minimal spacing, no merge |
+| `LayoutMode.Smushing` (`1`) | Characters may merge (default) |
+
+### `SmushingRules`
+
+| Flag | Value | Description |
+|---|---|---|
+| `SmushingRules.EqualCharacter` | 1 | Two identical characters → one |
+| `SmushingRules.Underscore` | 2 | Underscore replaced by hierarchy char |
+| `SmushingRules.Hierarchy` | 4 | Higher-ranked char wins |
+| `SmushingRules.OppositePair` | 8 | Opposing brackets → `\|` |
+| `SmushingRules.BigX` | 16 | `/+\` → `\|`, `\+/` → `Y`, `>+<` → `X` |
+| `SmushingRules.HardBlank` | 32 | Two hardblanks → one hardblank |
+
+## 🔗 ByteForge FIGLet Suite
+
+| Component | Description |
+|---|---|
+| [**FIGLet** (.NET)](https://www.nuget.org/packages/ByteForge.FIGLet) | Core C# library on NuGet |
+| [**@byte-forge/figlet** (TypeScript)](https://www.npmjs.com/package/@byte-forge/figlet) | TypeScript library on npm |
+| [**byteforge-figlet** (Python)](https://pypi.org/project/byteforge-figlet) | Python library on PyPI |
+| [**FIGPrint**](https://github.com/PaulStSmith/FIGLetAddIn/releases) | .NET CLI tool |
+| [**VS Extension**](https://marketplace.visualstudio.com/items?itemName=PaulStSmith.FIGLetCommentGenerator) | Visual Studio 2022+ extension |
+| [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=PaulStSmith.figlet-comment-generator) | VS Code extension |
+
+## 📜 License
+
+This library is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.
+
+## 💡 Credits
+
+- Original FIGLet concept by **Frank, Ian & Glenn**
+- Implementations by **Paulo Santos (ByteForge)**
+- FIGLet specification: [figlet.org](http://www.figlet.org/)
+
+## Support
+
+If you encounter any issues or have feature requests, please:
+1. Search existing [issues](https://github.com/PaulStSmith/figlet-comment-generator/issues)
+2. Create a new issue if needed
+
+---
+
+Made with ❤️ by Paulo Santos

byteforge_figlet-2.0.4.dist-info/RECORD

@@ -0,0 +1,13 @@
+byteforge_figlet/__init__.py,sha256=aOwtlM8gGlHdA3xQtwVVU3bZ7LzTsYXX9w6W2UohK1A,549
+byteforge_figlet/__main__.py,sha256=AdCiH9mvkvvDypmXG7oO3egoaTL52Ohb3S7YMf6WzS8,1757
+byteforge_figlet/fig_font.py,sha256=aIePuN-SNFyAtqAWgWw9o0XoSBMwv1ujzZMVgwqFiYY,9651
+byteforge_figlet/fig_let_renderer.py,sha256=2-A1-X9oEe42bQ39QcaJdJNyGeAdGFkGpiZNX9Dz_Qg,12173
+byteforge_figlet/layout_mode.py,sha256=wxbzAoD1GHI5OI3eytDvarhT_zps7-WSEgnYSWGbKek,488
+byteforge_figlet/smushing_rules.py,sha256=nWHkKfMxXiJB2SYmKt79iaXZIm8nkVp7HPoEMLIBXTk,939
+byteforge_figlet/fonts/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+byteforge_figlet/fonts/small.flf,sha256=jugBn6m34igxuEEEUAgL0_mfEtAz48hVeOIuqLekMio,11900
+byteforge_figlet-2.0.4.dist-info/METADATA,sha256=gTnztAMBmjiniTjVNWd5tJ_S9qWk12kBcSI8WHO_wso,9869
+byteforge_figlet-2.0.4.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+byteforge_figlet-2.0.4.dist-info/entry_points.txt,sha256=kum9RlaWA-ecPNXxc_BWdj22wbxRgjzgmYKH6ZmUEPM,60
+byteforge_figlet-2.0.4.dist-info/licenses/LICENSE,sha256=123n61EbdLVCrgINOjkuGgJ0aYyJfBkwbdWD6eDNdng,1073
+byteforge_figlet-2.0.4.dist-info/RECORD,,

byteforge_figlet-2.0.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

byteforge_figlet-2.0.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+figprint = byteforge_figlet.__main__:main

byteforge_figlet-2.0.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Paulo Santos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.