An open API service indexing awesome lists of open source software.

https://github.com/systemslibrarian/bible-ai-prompting-class

Learn AI prompt engineering through Bible study — NIV edition with lessons, examples, and an expanded prompt library.
https://github.com/systemslibrarian/bible-ai-prompting-class

ai bible christianity faith prompt-engineering

Last synced: 14 days ago
JSON representation

Learn AI prompt engineering through Bible study — NIV edition with lessons, examples, and an expanded prompt library.

Awesome Lists containing this project

README

          

# Bible + AI Prompting Masterclass (NIV)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/systemslibrarian/bible-ai-prompting-class/blob/main/bible_ai_prompting_masterclass_NIV_expanded.ipynb)

Learn practical prompt engineering through guided Bible study exercises.

This repository contains:
- **Full notebook** — `bible_ai_prompting_masterclass_NIV_expanded.ipynb` (detailed lessons with practice cells)
- **Compact notebook** — `bible_ai_prompting_compact.ipynb` (same 7 techniques, powered by a reusable helper module)
- **Streamlit web app** — `app.py` (interactive UI, no Jupyter required)

## What You Will Learn
- Role prompting (persona + audience)
- Contextual prompting (historical and literary grounding)
- Few-shot prompting (teach by example)
- Comparative synthesis across passages
- Socratic prompting for reflection
- Format & constraint prompting (include/exclude boundaries)
- Meta-prompting (AI writes better prompts for you)

## Quick Start

### Option 1: Google Colab
1. Click the Colab badge above.
2. Run the setup cell.
3. Enter your `OPENAI_API_KEY` when prompted.
4. Run cells top-to-bottom.

### Option 2: Local Jupyter
```bash
pip install -r requirements.txt
jupyter lab
```
Open either notebook and run in order.

### Option 3: Streamlit Web App
```bash
pip install -r requirements.txt
streamlit run app.py
```
The app opens in your browser with tabs for interactive study, advanced templates, the prompt library, and session history.

## Environment
```bash
export OPENAI_API_KEY="your_key_here"
```
The setup cell / Streamlit sidebar also accept the key interactively.

## Project Structure
```text
.
├── bible_ai_prompting_masterclass_NIV_expanded.ipynb # full notebook
├── bible_ai_prompting_compact.ipynb # compact notebook
├── app.py # Streamlit web UI
├── bible_ai/
│ ├── __init__.py
│ └── helpers.py # reusable BibleAI class + prompt catalogues
├── scripts/
│ └── notebook_quality_check.py
├── .github/
│ └── workflows/
│ └── ci.yml # GitHub Actions CI
├── requirements.txt
├── Makefile
└── README.md
```

## Using the Helper Module

The `bible_ai` package can be used in any Python script or notebook:

```python
from bible_ai import BibleAI, TECHNIQUES

ai = BibleAI() # reads OPENAI_API_KEY from env
print(ai.study("John 3:16", "Explain Simply")) # one-liner study
print(ai.advanced("Word Study (Hebrew/Greek)")) # advanced template
ai.export() # save JSON + Markdown
```

## Exports
Session logs are exported to:
- `bible_ai_exports/session_.json`
- `bible_ai_exports/session_.md`

## CI / Quality Checks

Every push and PR runs the GitHub Actions workflow (`.github/workflows/ci.yml`) which:
- Validates both notebooks with `nbformat` and the custom quality checker
- Compiles the helper module and Streamlit app (syntax check)

Run locally:
```bash
make check # notebook quality
make lint # Python syntax
```

## Safety Note
AI is a study companion, not a replacement for prayer, sound interpretation, and wise pastoral counsel.

Always compare generated content with Scripture in context.

## License
MIT