Installation

Prerequisites

Python 3.8 or later
pip (bundled with most Python installers)
A terminal that supports ANSI colors for the best output (the rich library used by H9A)

Install from PyPI

python -m pip install h9a

For screenshot support, install the extra:

python -m pip install "h9a[screenshot]"

Install from the repository

git clone https://github.com/rkriad585/h9a.git
cd h9a
python -m pip install .

This installs the h9a package and the h9a console command.

Editable install for development

python -m pip install -e .

Screenshot support

Pillow is an optional dependency, used only for --screenshot and generate_screenshot(). Install it with the screenshot extra:

python -m pip install .[screenshot]
# or, for an editable dev install:
python -m pip install -e .[screenshot]

Install dependencies manually

The package declares three dependencies:

rich — styled and colorized console output
pyfiglet — ASCII-art banner generation
Pillow — screenshot generation (optional)

You can install them directly without installing the package:

python -m pip install rich pyfiglet
python -m h9a

Note: When running python -m h9a without installing the package, you must run it from the repository root so that the h9a/ package directory is importable.

Verify the installation

h9a

If you see the banner and the final result (20 times), the installation is complete.

Optional: run in a container

A Dockerfile is provided. Build and run it with:

docker build -t h9a .
docker run --rm h9a

See deployment.md for details.

Back to Home