README.md

Profile Picture Generator

Generate a random profile picture based on given text!

🔎 Examples

truman	trumully	github	python is awesome

🪄 Quick Start

pfp-generator [-h] [-s <size>] [-bg <color>] [-c <color>] [-w <weight>] [-b <amount>] [--save] [--ascii] [text]

Generate profile pictures.

positional arguments:
  text                  Text to generate from. Random text is used if not provided.

options:
  -h, --help            show this help message and exit
  -s <size>, --size <size>
                        The size of the base pattern. Defaults to 5.
  -bg <color>, --background <color>
                        The color of the background.
  -c <color>, --color <color>
                        The color of the profile picture.
  -w <weight>, --color-weight <weight>
                        The weight of the profile picture color.
  -b <amount>, --batches <amount>
                        The number of profile pictures to generate.
  --save                Ask to save the file.
  --ascii               Display the ASCII representation of the profile picture.

📦 Setting Up

Prerequisites

pipx or pip is required. Using pipx is highly recommended.

Installation

With pipx:

pipx install git+https://github.com/trumully/pfp_generator

With pip (not recommended):

python -m pip install -U git+https://github.com/trumully/pfp_generator

🧰 Development

Prerequisites

Install poetry with pipx:

pipx install poetry

Installing

Clone the repository:

git clone https://github.com/trumully/pfp_generator.git

Activate the virtual environment:

cd pfp_generator
poetry shell

Install dependencies:

poetry install

🧬 Tests

Run tests with pytest

poetry run pytest