Skip to main content

Interactive Bible Reading

Project description

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

Project details


Download files

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

Source Distribution

bibleit-0.2.1.tar.gz (47.0 kB view details)

Uploaded Source

Built Distributions

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

bibleit-0.2.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (55.4 kB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64manylinux: glibc 2.28+ x86-64

bibleit-0.2.1-cp311-cp311-macosx_11_0_arm64.whl (42.7 kB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

File details

Details for the file bibleit-0.2.1.tar.gz.

File metadata

  • Download URL: bibleit-0.2.1.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bibleit-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e210dbdfbaa4e6eec3d0c4650002b4594e57c076ec84f07e55805489258b1960
MD5 b44edb20f7291b44c85894e5f6ce95f2
BLAKE2b-256 89c0155aa1114402c37e22f8ded30eea53fecc983fbe0457cf7cefb31b26cfc3

See more details on using hashes here.

File details

Details for the file bibleit-0.2.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for bibleit-0.2.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 28a40f7dfde56749cfb97bce0835d1daec561c660f5d6493b73fa13faac4acc0
MD5 1294d1b3fc51338c573e149b5160e856
BLAKE2b-256 a9af9dccbe6752682d2c911b9962c31ca8c6a9d539e44a80b6f591ab1b3d892e

See more details on using hashes here.

File details

Details for the file bibleit-0.2.1-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for bibleit-0.2.1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4c488cdee01c4272c3fc8464e73c36a72d4e0af9f7d588c434505d90cab38e16
MD5 4f10eb97aa40d3559155b87559c1f8d6
BLAKE2b-256 7f3ae1d8a934f8c65f52d0f34a03b5098c3aa6b51d2f02a36544f980c546a4d0

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