Skip to content
Datta Tele edited this page Feb 24, 2025 · 3 revisions

ArtGen Wiki 🚀🎨

Screenshot 2025-02-24 164032

Welcome to the ArtGen project wiki! Here you'll find a quick overview of the project, installation instructions, usage examples, and more.

Table of Contents


Overview

ArtGen is a Python CLI tool that generates ASCII art, stylized text, or locally saved images from a brief description or keyword. It does the following:

  1. Fetch an image using DuckDuckGo Image Search.
  2. Convert the fetched image to ASCII art (using ascii_magic).
  3. Fallback to pyfiglet if no image is found.
  4. Save a fetched image locally, if needed.

Why use ArtGen?

  • Quickly generate ASCII art for fun or decorative CLI banners.
  • Display stylized text with minimal commands.
  • Experiment with image-based text transformations.

Features

  • interactive: web or cli mode generate ascii art and allow more controls.
  • Generate ASCII art from any keyword: artgen generate_art "cat"
  • Stylize text in various fonts: artgen generate_word "Hello"
  • Fetch and save images locally: artgen generate_img "Sunflower"

Installation

Poetry (Recommended)

  1. Install Poetry (if you don’t have it):
    curl -sSL https://install.python-poetry.org | python -
  2. Add Poetry to your PATH (depending on your operating system).
  3. Clone the ArtGen repository or install directly from PyPI:
   pip install artgen --upgrade

or

   poetry add artgen
  1. Verify installation:
   artgen --help

Pip

If you prefer using pip directly: pip install artgen

Usage

After installation, you can run the artgen command from your terminal:

artgen [COMMAND] "description or query"

Interactive Mode

  artgen interactive

It will launch web view on http://localhost:5000/ image

For cli interactive mode:

  artgen interactive_cli

Screenshot 2025-02-24 163847

CLI Commands

  1. generate_art
  • Fetches an image based on the query, converts it to ASCII art, and displays it in the terminal.
  • If no image is available, falls back to a stylized text output.

Example:

artgen generate_art "sunflower"

This will attempt to fetch an image of a sunflower, create ASCII art, and print it to the terminal.

Screenshot 2025-02-24 163528

  1. generate_word
  • Uses PyFiglet to create stylized text banners for your chosen word or phrase.

Example:

   artgen generate_word "HELLO"

This prints a PyFiglet banner for "HELLO"

  1. generate_img
  • Fetches an image based on the query and saves it locally to an images/ folder.

Example:

   artgen generate_img "sunflower"

This saves the fetched sunflower image as ./images/sunflower.jpg and opens it.

Screenshot 2025-02-24 164458

Contributing

We welcome all contributions! Whether you want to improve documentation, fix bugs, or add new features:

Fork the [ArtGen repository](https://github.com/yourusername/artgen).
Create a new branch for your feature or bugfix.
Commit your changes and push to your fork.
Open a Pull Request describing your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.