Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 1.87 KB

File metadata and controls

92 lines (69 loc) · 1.87 KB

Setup Guide - Linux

Prerequisites

  • Python 3.12+ (recommended) or Python 3.9+
  • pip and venv (usually included with Python)
  • Google AI API Key - Get one from Google AI Studio

Installation

  1. Clone the repository (if applicable) or navigate to the project directory:

    cd bible-planner-image-generator
  2. Install Python 3.12 (if not already installed):

    Ubuntu/Debian:

    sudo apt update
    sudo apt install python3.12 python3.12-venv python3.12-pip

    Fedora/RHEL:

    sudo dnf install python3.12 python3.12-pip

    Arch Linux:

    sudo pacman -S python312

    Or use your distribution's package manager to install Python 3.12 or later.

  3. Create a virtual environment:

    python3.12 -m venv .venv

    Alternative: If using Python 3.9+:

    python3 -m venv .venv
  4. Activate the virtual environment:

    source .venv/bin/activate
  5. Install dependencies:

    pip install -r requirements.txt

Configuration

  1. Copy the .env.example file to create your .env file:

    cp .env.example .env
  2. Edit the .env file and replace YOUR_KEY_HERE with your actual Google AI API key:

    # Open in your preferred editor, or use:
    nano .env
    # or
    vim .env

    Note: The .env file is already in .gitignore to keep your API key secure.

Running the Project

Option 1 - Run directly (uses venv Python via shebang):

./src/main.py

Option 2 - Activate venv and run:

source .venv/bin/activate
python src/main.py

Option 3 - Use venv Python explicitly:

.venv/bin/python src/main.py

Note: Make sure the script is executable: chmod +x src/main.py