asciigenator 0.0.1

A Python library for generating ASCII art from text

asciigenator

A lightweight Python library for generating ASCII art from text.

Table of Contents

• Installation
• Usage
  • Basic Python Usage
  • Command Line Usage
• Testing
• Development Notes

---

Installation

• Clone the repository:

  git clone https://github.com/bhatishan2003/asciigenator.git
  cd asciigenator
  

• Install the package:

  pip install .
  

• For development (editable mode):

  pip install -e .
  

Usage

Basic Python Usage

import asciigenator

# Test simple font
print("=== Simple Font ===")
print(asciigenator.generate("Hello", font="simple"))

# === Simple Font ===
#  *   **  ** *** ***  ** *** *   *
# * * *   *    *   *  *   *   **  *
# ***  *  *    *   *  * * **  * * *
# * *   * *    *   *  * * *   *  **
# * * **   ** *** ***  ** *** *   *

print("\n=== Block Font ===")
print(asciigenator.generate("Ishan", font="block"))

# === Block Font ===
#   █
#  █ █  ████  ████ █████ █████  ████ █████  █   █
#  █ █  █     █       █     █   █     █     ██  █
# █████  ███  █       █     █   █  ██ ████  █ █ █
# █   █     █ █       █     █   █   █ █     █  ██
# █   █ ████   ████ █████ █████  ████ █████ █   █

print("\n=== Available Fonts ===")
print(asciigenator.list_fonts())

# === Available Fonts ===
# ['block', 'simple']

Command Line Usage

asciigenator "Hello World"
asciigenator "Hello World" --font block
asciigenator --list-fonts
asciigenator "Hello World" --font block  --border "#"
asciigenator "Hello World"  --font block --color magenta

Testing

Run all tests:

pytest -v

Development Notes

• Pre-commit

  We use pre-commit to automate linting of our codebase.

  • Install hooks:

    pre-commit install
    

  • Run Hooks manually (optional):

    pre-commit run --all-files
    

• Ruff:

  • Lint and format:

    ruff check --fix
    ruff format