Skip to main content

BibleMate AI - Automate Your Bible Study

Project description

# BibleMate AI WEB

This repository focuses only on the Web UI, HTTP and API servers of a larger project, [BibleMate AI](https://github.com/eliranwong/biblemate).

For CLI Version / MCP Server / Agent Mode / Partner Mode / Bible Data, read https://github.com/eliranwong/biblemate

BibleMate AI Web Application - Web GUI & Http Server & API Server

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

## Latest New - Agent Mode on the BibleMate Web Version

We are pleased to announce that Agent Mode is now fully integrated across both the BibleMate Web and CLI platforms, providing a unified experience for all users.

### Additional Options for Agent Mode Setup

Agent Mode consumes more tokens than standard mode. Consider restricting public access to manage costs.

Configuration options disable_agent_mode and limit_agent_mode_once_daily are designed to limit access to Agent Mode.

To disable public access to agent mode, set:

> config.disable_agent_mode=True

To daily limit access to agent mode, set:

> config.limit_agent_mode_once_daily=True

Users can still use the Agent Mode by entering a custom token or their own API keys in Preferences, even either of the two options above are set to True.

Note: Setting a daily limit requires [Google Account authentication](https://github.com/eliranwong/biblemateweb/blob/main/docs/google_drive_notes_setup.md), as users’ access settings are stored directly in users’ own Google Drive. BibleMate AI is designed for privacy; our servers do not store any user data.

## Recent Updates

[Hebrew & Greek Tooltips](https://youtu.be/qCMku8-UZ3I)

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

[User Customization](https://youtu.be/QMJ2oo1qkjY)

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

[Bible Audio](https://youtu.be/GL98FaJlYUQ)

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

[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

  • Web UI runs with all popular web browsers

  • Http & API Servers runs on any standard platforms

  • API Data Access independent of running platforms

# Public Demo

https://biblemate.gospelchurch.uk

# Local Setup

> pip install –upgrade biblemateweb

One-off Data Setup:

> biblematedata

Run HTTP & API Servers:

> biblemateweb

Open Web UI:

> open http://localhost:33355

## API Usage

Run API Client:

> biblemateapi -h

Read more at:

https://github.com/eliranwong/biblemateweb/blob/main/tests/api_client.py

https://github.com/eliranwong/biblemateweb/blob/main/docs/api_query.md

## Setup Bible Notes Sync with Google Accounts

The BibleMate web UI allows users to create and store personal study notes for any book, chapter, or verse directly in Google Drive. This integration ensures that all notes stay synced across devices, making them easily accessible whenever and wherever you need them.

For demo, check out https://biblemate.gospelchurch.uk

Read setup notes at https://github.com/eliranwong/biblemateweb/blob/main/docs/google_drive_notes_setup.md

## Support Exported Agent Mode Report in Word Document Format

pandoc is required to export content to DOCX format.

To install, for example, on Debian/Ubuntu:

> sudo apt install pandoc

## Customization

Server Side:

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

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/biblemateweb.config, then restart biblemateweb.

## Public Deployment

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

biblemateweb-0.2.89.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

biblemateweb-0.2.89-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file biblemateweb-0.2.89.tar.gz.

File metadata

  • Download URL: biblemateweb-0.2.89.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for biblemateweb-0.2.89.tar.gz
Algorithm Hash digest
SHA256 03363ae194a20b45d043fbcf6ad82dabd54191738bbaa5140527ef7a90b371e5
MD5 20232b43def38ecc423bdd3a544d9200
BLAKE2b-256 6fb619c6e3d1486f5bb2a53043baed27c72a2416f8fc043aaa2d59376f769b66

See more details on using hashes here.

File details

Details for the file biblemateweb-0.2.89-py3-none-any.whl.

File metadata

  • Download URL: biblemateweb-0.2.89-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for biblemateweb-0.2.89-py3-none-any.whl
Algorithm Hash digest
SHA256 35c3f930918d2d147361e13aa5c595a7a1ad1ae04c6364acb58e46526bc91893
MD5 bc200cab3e2951cff21b16026eaf231b
BLAKE2b-256 44870e939561ba72a7adfab8fb746d5966f0a927b9622f64c25ae158a0529704

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page