Skip to content

corenting/roboquote

Repository files navigation

roboquote

Generate random "inspirational" quotes images by using an AI text generation model.

The following models can be used:

Examples

How it works

  1. A background is picked from Unsplash, either randomly or by giving roboquote a search query.
  2. The model is prompted to give an "inspirational" quote for the given background search query.
  3. The quote is inserted on the image which is then saved.

Usage

Installation

  1. Install the project with poetry by doing poetry install.
  2. Set environment variables for configuration (the project uses environs so you can also put the variable in a env file):
    • HUGGING_FACE_ACCESS_TOKEN (required): your Hugging Face access token for their Inference API
    • GROQ_CLOUD_API_KEY (required): your GroqCloud API key for their API
    • LOG_LEVEL (optional, default is WARNING): log level of the application
    • WEB_DEBUG (optional, default is False): if you want to run the web app in debug mode (should not be required)

CLI usage

Run poetry run python main.py my_file.jpg to generate a new random image.

See poetry run python main.py --help for the available options.

Web usage

The web version is a Starlette application (roboquote.web.app:app).

It can be launched quickly locally with uvicorn through the make run-web command.

Credits