Orthodox Study Bible TUI

A modern, offline-first Terminal User Interface (TUI) for studying the Orthodox Study Bible (OSB). Built with Python and the Textual framework, it combines traditional scripture study with modern features like local AI assistance and full-text search.

---

📖 Table of Contents

• Features
• Requirements
• Setup & Installation
• Keybindings
• AI Chat (Optional)
• Developer Guide
• SEO & AI Optimization
• License

---

✨ Features

• Full Scripture Text: Complete 78-book canon of the OSB (35,945 verses).
• Commentary & Cross-References: Integrated study notes available instantly for every verse.
• Full-Text Search (FTS5): Blazing fast search across all books and commentary.
• Personal Study Tools: Add annotations, bookmarks, and color-coded highlights.
• Daily Lectionary: Built-in tracking for the Menaion and Paschal cycles (Julian calendar).
• Local AI Chat: Stream theological inquiries directly through Ollama (100% private, no cloud).
• Modern UI: Dark and Sepia themes, responsive layout, and Vim-style navigation.
• Markdown Export: Export your personal notes and study progress to Markdown.

---

🛠 Requirements

• Python 3.11+
• uv (highly recommended) or pip.
• Orthodox Study Bible EPUB: You must provide your own legally acquired copy of the OSB EPUB.

---

🚀 Setup & Installation

One-Command Install (Recommended)

curl -sSL https://raw.githubusercontent.com/IFAKA/orthodox-study-bible/main/install.sh | sh
osb

The scripture database is downloaded automatically on first launch (~15 MB, one time only). The app works fully offline after that.

Manual Install

uv tool install git+https://github.com/IFAKA/orthodox-study-bible
osb

From Source (with EPUB)

git clone https://github.com/IFAKA/orthodox-study-bible
cd orthodox-study-bible
cp /path/to/the-orthodox-study-bible.epub .
uv run osb

---

⌨️ Keybindings

Key	Action
j / k	next / previous verse
J / K	next / previous chapter
h / l	focus left / right pane
g g	first verse of chapter
G	last verse of chapter
t	toggle book tree sidebar
/	search
o	edit annotation for focused verse
m	cycle highlight color
b	bookmark verse
a	toggle Commentary / Chat tab
L	today's lectionary readings
N	My Notes (all annotations + bookmarks)
T	toggle Dark / Sepia theme
E	export annotations to Markdown
q	quit / close modal

---

🤖 AI Chat (Optional)

Enhance your study with local AI. Install Ollama and pull your preferred model:

ollama serve
ollama pull llama3.2

Switch to the Chat tab in the app with a. All conversations remain on your machine.

---

👨‍💻 Developer Guide

Verifying Features

• Run uv run osb --reimport to test the EPUB parser.
• Run uv run osb --reset to wipe local data while keeping scripture.
• Check uv run osb --db-path for the SQLite file location.

Running Tests

Ensure an OSB EPUB is present in the root directory:

uv run pytest tests/test_parser.py

---

🔍 SEO & AI Optimization

This project is optimized for both search engines and AI agents.

• Structured Metadata: Defined in pyproject.toml.
• AI Context: See llms.txt for a technical summary optimized for Large Language Models.
• Social Preview: Instructions for adding a repository social image.

---

📜 License

• Code: MIT License (see LICENSE).
• Content: The Orthodox Study Bible text is copyright © St. Athanasius Orthodox Academy. This software is a tool for personal study and does not distribute copyrighted text.

---

Built with ❤️ for the Orthodox community.