Metadata-Version: 2.1
Name: searchbible
Version: 0.1.6
Summary: Search Bible AI - Integrate Unique Bible App resources with AI tools
Home-page: https://letmedoit.ai
Author: Eliran Wong
Author-email: support@letmedoit.ai
License: GNU General Public License (GPL)
Project-URL: Source, https://github.com/eliranwong/searchbibleai
Project-URL: Tracker, https://github.com/eliranwong/searchbibleai/issues
Project-URL: Documentation, https://github.com/eliranwong/searchbibleai/wiki
Project-URL: Funding, https://www.paypal.me/MarvelBible
Keywords: ai unique bible search openai google chatgpt gemini chromadb
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: requests
Requires-Dist: argparse
Requires-Dist: prompt-toolkit
Requires-Dist: Pygments
Requires-Dist: pyperclip
Requires-Dist: openai
Requires-Dist: google-cloud-aiplatform
Requires-Dist: apsw
Requires-Dist: sentence-transformers
Requires-Dist: chromadb
Requires-Dist: python-vlc
Requires-Dist: tiktoken

# Search Bible AI

Integrate Unique Bible App resources with AI tools

Built upon our projects, the [UniqueBible App](https://github.com/eliranwong/UniqueBible) and [LetMeDoIt AI](https://github.com/eliranwong/letmedoit), SearchBible AI is our latest Bible app that aims to integrate our comprehensive Bible resources with the recent advancements in AI technology and tools.

# Installation / Upgrade

> pip install --upgrade searchbible

# Usage

> searchbible

> searchbible \<query\>

e.g.

> searchbible "John 3:16"

> searchbible "Jesus loves"

* enter a single reference to display a full chapter

* enter multiple references to display verses

* enter a bible version abbreviation, e.g. KJV, to switch to a particular bible version

* enter a search query to perform a simple search

* enter '.verses' or press 'Ctrl+F' to perform a detailed search for verses

* enter '.paragraphs' or press 'Esc+F' to perform a detailed search for paragraphs

* press 'Ctrl+P' to toggle bible comparison

* press 'Esc+P' to select bible versions for comparison

* press 'Ctrl+G' to launch ChatGPT chatbot

* press 'Esc+G' to luanch GeminiPro chatbot

* press 'Ctrl+K' to display available shortcut keys

* enter '{config.exit_entry}' or press 'Ctrl+Q' to exit current feature of quit the app

## Shortcuts

* enter ":" to reload previously selected chapter and verse

* enter "\<chatper_number\>:" to open a particular chapter in the same book, e.g. "3:"

* enter ":\<verse_number\>" to select a particular verse in the same chapter, e.g. ":16"

To start with default entry from terminal, e.g.:

> searchbible KJV

> searchbible "John 3:16; Rm 5:8"

> searchbible "Jesus love"

## UBA module converter

To convert an UniqueBible App bible files, with a given path, e.g. /temp/KJV.bible

> searchbibleconverter -b /temp/KJV.bible

For batch conversion, place multiple bible files in a folder, e.g. /temp/

> searchbibleconverter -b /temp/

![batch_conversion](https://github.com/eliranwong/searchbibleai/assets/25262722/18fb9bf6-1e57-45ca-85c5-232c5b78d0b2)

# Progress

1. Support conversion of UnqiueBible App bibles (done)

2. Build simple cli interface for reading single bible chapter (done)

3. Build simple cli interface for searching verses (done)

4. Build simple cli interface for searching paragraphs (done)

5. Integrate bible comparison feature (done)

6. Integrates ChatGPT and Gemini Pro features (partial)

7. Support more UnqiueBible App bible resources (pending)

8. Build a Qt-based graphical user interface, like we do in [UniqueBible App](https://github.com/eliranwong/UniqueBible) (pending)

# New Features that are not available in oiginal Unique Bible App

* bible modules vector database formats on top of SQLite format

* support searching individual paragraphs in addition to searching individual verses

* support semantic searches (i.e. search for meaning); both in verses and paragraphs

* support cross-language semantic searches, e.g. search a Greek bible with English input or search an English bible with Chinese input

* combination of literal search, semantic search and regular expression search in a single search

* more to be added
