Metadata-Version: 2.4
Name: biblemategui
Version: 0.0.64
Summary: BibleMate AI - Automate Your Bible Study
Home-page: https://biblemate.ai
Author: Eliran Wong
Author-email: support@marvel.bible
License: GNU General Public License (GPL)
Project-URL: Source, https://github.com/eliranwong/biblemategui
Project-URL: Tracker, https://github.com/eliranwong/biblemategui/issues
Project-URL: Documentation, https://github.com/eliranwong/biblemategui/wiki
Project-URL: Funding, https://www.paypal.me/MarvelBible
Keywords: mcp agent biblemate ai anthropic azure chatgpt cohere deepseek genai github googleai groq llamacpp mistral ollama openai vertexai xai
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10, <3.13
Requires-Dist: agentmake>=1.1.81
Requires-Dist: biblemate>=0.2.43
Requires-Dist: nicegui>=3.2.0
Requires-Dist: apsw
Provides-Extra: genai
Requires-Dist: google-genai>=1.46.0; extra == "genai"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# BibleMate AI GUI

BibleMate AI Web Application - Web GUI

BibleMate AI Web Version is designed to combine the most valuable features from the following two projects into a single, unified web interface:

https://github.com/eliranwong/biblemate

and

https://github.com/eliranwong/UniqueBible

## Recent Updates

[Cross-Highlighting & Synchronized Scrolling](https://youtu.be/TDyT1ioesmY)

[![Watch the video](https://img.youtube.com/vi/TDyT1ioesmY/maxresdefault.jpg)](https://youtu.be/TDyT1ioesmY)

[UI Overview](https://youtu.be/UL8b1O97560)

[![Watch the video](https://img.youtube.com/vi/UL8b1O97560/maxresdefault.jpg)](https://youtu.be/UL8b1O97560)

# Supported Platforms

1. Web Mode to run on popular web browsers

2. Desktop Mode on Windows/macOS/Linux

# Development in Progress ...

Install for testing:

> pip install --upgrade biblemategui

Run:

> biblemategui

Open:

http://localhost:33355

## Customization

Server Side:

Save changes of `avatar`, `port` and `storage_secret` key in ~/biblemate/biblemategui.config, then restart `biblemategui`.

User Preferences:

http://localhost:33355/settings

## Storage Secret Key

A Storage Secret Key is necessary for deployment.

You may generate a random key by running `openssl rand -hex 32` or `openssl rand -base64 32`

Save it as the value of `config.storage_secret` in ~/biblemate/biblemategui.config, then restart `biblemategui`.

## Use Existing UniqueBible App Data

Run the following command first before the first launch of `biblemategui`

```
cd
mkdir biblemate
cd biblemate
ln -s ../UniqueBible/marvelData data
cd data
ln -s ../../UniqueBible/audio/ audio
mkdir original
cd original
ln -s ~/UniqueBible/marvelData/bibles/MOB.bible ORB.bible
ln -s ~/UniqueBible/marvelData/bibles/MIB.bible OIB.bible
ln -s ~/UniqueBible/marvelData/bibles/MPB.bible OPB.bible
ln -s ~/UniqueBible/marvelData/bibles/MTB.bible ODB.bible
ln -s ~/UniqueBible/marvelData/bibles/MAB.bible OLB.bible
```

## Server Setup

Please read https://nicegui.io/documentation/section_configuration_deployment#server_hosting

## Supported Parameters with URL


* t: str | None = None, # Token for using custom data: allow users to pass a custom token, which won't be stored, via a parameter when using public devices. For personal devices, enable persistent settings using `custom_token`.
* k: bool | None = True, # keep valid specified parameters in history
* m: bool | None = True, # display menu
* l: int | None = None, # layout; either: 1 (bible area only) or 2 (bible & tool areas) or 3 (tool area only)
* bbt: str | None = None, # bible bible text
* bb: int | None = None, # bible book
* bc: int | None = None, # bible chapter
* bv: int | None = None, # bible verse
* tbt: str | None = None, # tool bible text
* tb: int | None = None, # tool book
* tc: int | None = None, # tool chapter
* tv: int | None = None, # tool verse
* tool: str | None = None, # supported options: bible, ...
