Installation

Requirements

Naamkaran requires Python 3.9 or higher and the following dependencies:

The easiest way to install naamkaran is from PyPI using pip:

pip install naamkaran

If you want to use the Gradio web app or Flask API, install with web dependencies:

pip install "naamkaran[web]"

For development, clone the repository and install in editable mode:

git clone https://github.com/appeler/naamkaran.git
cd naamkaran
pip install -e ".[dev,test]"

This will install all development dependencies including pytest, black, isort, flake8, mypy, and pre-commit hooks.

To verify the installation, try generating some names:

from naamkaran.generate import generate_names

names = generate_names(starting_letter='A', gender='F', num_names=3)
print(names)

Or test the command-line interface:

generate_names --help