byteforge-figlet 2.0.4__tar.gz

byteforge_figlet-2.0.4/.gitignore

@@ -0,0 +1,376 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+dist/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# Claude Code worktrees
+.claude/worktrees/
+.claude/settings.local.json
+
+# VS Code extension — webpack bundles (generated by `npm run build:webview`)
+FIGLet.VSCodeExtension/media/*.js
+FIGLet.VSCodeExtension/media/*.js.map
+FIGLet.VSCodeExtension/media/*.LICENSE.txt
+
+# Python Virtual Environments
+.venv/

byteforge_figlet-2.0.4/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.

byteforge_figlet-2.0.4/PKG-INFO

@@ -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