bibleit 0.1.2

Interactive bible reading

bibleit python

Interactive Bible reading application for the terminal, built with Python and Textual.

Features

• Interactive terminal UI
• Browser access using Textual Web
• Docker support
• Development workflow with Make

Requirements

• Python 3.11+
• GNU Make

Installation

Clone the repository:

git clone https://github.com/mittel-labs/bibleit.git
cd bibleit/python

Install development dependencies:

make install

Usage

Run the terminal application:

make run

Run the browser version:

make serve

Then open:

http://localhost:8000

Development

Run with Textual development tools:

make run-dev

Run browser version with hot reload:

make serve-dev

Open a Python shell inside the virtual environment:

make shell

Run tests:

make test

Run lint:

make lint

Format code:

make lint-fix

Build distribution packages:

make build

Install local wheel:

make install-local

Browser server configuration

The browser server supports the following environment variables:

Variable	Default	Description
BIBLEIT_SERVE_HOST	0.0.0.0	Bind address
BIBLEIT_SERVE_PORT	8000	Server port
BIBLEIT_SERVE_PUBLIC_URL	http://localhost:8000	Public URL used by the browser/websocket client

Example:

export BIBLEIT_SERVE_HOST=0.0.0.0
export BIBLEIT_SERVE_PORT=8000
export BIBLEIT_SERVE_PUBLIC_URL=http://localhost:8000

make serve

Docker

Build the image:

docker build -t bibleit .

Run terminal mode:

docker run -it bibleit

Run browser mode:

docker run -p 8000:8000 bibleit serve

Then open:

http://localhost:8000