| Name | bibli JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A command-line interface Bible application for programmers |
| upload_time | 2025-07-08 17:30:53 |
| maintainer | None |
| docs_url | None |
| author | guzus |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
bible
cli
religion
scripture
terminal
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Bible CLI
A powerful command-line interface for Bible reading and study, designed specifically for programmers and terminal enthusiasts.
## Features
- 🔍 **Fast Search** - Full-text search with regex support and context
- 📖 **Multiple Translations** - Support for various Bible translations
- 🎨 **Rich Terminal UI** - Beautiful ASCII art and interactive TUI
- 🔖 **Bookmarks** - Save and organize your favorite verses
- 📊 **Reading History** - Track your Bible reading progress
- 🔧 **MCP Integration** - Model Context Protocol server for AI tools
- ⚙️ **Customizable** - Extensive configuration options
- 🎯 **Developer-Friendly** - Designed with programmers in mind
- 📈 **Database Statistics** - View Bible database information and statistics
## Installation
### From PyPI (when published)
```bash
pip install bibli
# or
pipx install bibli
```
### From Source with UV (Recommended)
```bash
git clone https://github.com/guzus/bible-cli
cd bible-cli
uv sync
```
### From Source with pip
```bash
git clone https://github.com/guzus/bible-cli
cd bible-cli
pip install -e .
```
## Quick Start
```bash
# Read a specific verse
uv run bible read john 3:16
# Read a range of verses
uv run bible read genesis 1:1-5
# Read an entire chapter
uv run bible read psalms 23
# Search for verses
uv run bible search "love your enemies"
# View database information
uv run bible info
# Interactive mode
uv run bible
# Get help
uv run bible --help
```
## Commands
### Information Commands
- `bible info` - Display Bible database information and statistics with ASCII art
### Reading Commands
- `bible read <book> <chapter>:<verse>` - Read specific verse(s)
- `bible goto <reference>` - Jump directly to a reference
- `bible random` - Display a random verse
- `bible daily` - Show verse of the day
- `bible nav <book> <reference>` - Navigate Bible interactively
### Search Commands
- `bible search <query>` - Search for words or phrases
- `--exact` - Exact phrase matching
- `--case-sensitive` - Case-sensitive search
- `--book <name>` - Limit search to specific book
- `--testament <old|new>` - Limit to testament
- `--context <n>` - Show n verses of context
- `--limit <n>` - Maximum number of results
### Bookmark Commands
- `bible bookmarks` - List saved bookmarks
- `bible bookmark add <reference>` - Add bookmark
- `--name <name>` - Bookmark name
- `--notes <notes>` - Bookmark notes
- `bible history` - Show reading history
### Interactive Mode
Launch the Terminal User Interface:
```bash
uv run bible interactive
# or just
uv run bible
```
#### Keyboard Shortcuts
- `j/k` or `↓/↑` - Navigate verses
- `h/l` or `←/→` - Previous/Next chapter
- `Space/b` - Page down/up
- `g` - Go to verse
- `/` - Search mode
- `r` - Random verse
- `m` - Bookmark current verse
- `?` - Help
- `q` - Quit
#### Interactive Reader Navigation
When using `--interactive` flag with read commands:
- `n` or `Enter` - Next verse
- `p` - Previous verse
- `N` - Next chapter
- `P` - Previous chapter
- `g` - Go to specific verse
- `b` - Bookmark current verse
- `q` - Quit
## MCP Server
The Bible CLI includes a **Model Context Protocol (MCP) server** that allows AI applications like Claude to access Bible functionality directly.
### Starting the MCP Server
```bash
uv run bibli mcp-server
```
The server runs using stdio transport and can be connected to by MCP clients.
### MCP Capabilities
#### 🔧 Tools (AI can call these functions)
- **`search_verses`** - Search for Bible verses containing specific text
- **`get_verse`** - Get a specific Bible verse by reference (e.g., "John 3:16")
- **`get_chapter`** - Get all verses from a Bible chapter
- **`get_random_verse`** - Get a random Bible verse
- **`get_cross_references`** - Find related verses for cross-referencing
#### 📚 Resources (Contextual data for AI)
- **`bible://books`** - List of all Bible books with metadata
- **`bible://book/{book_name}`** - Information about a specific book
#### 💭 Prompts (Templates for Bible study)
- **`bible-study`** - Generate comprehensive Bible study materials
- **`verse-explanation`** - Provide detailed verse explanations and context
- **`devotional`** - Create devotional reflections based on passages
- **`sermon-outline`** - Generate sermon outlines from Bible texts
### Connecting to Claude Desktop
Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"bible-cli": {
"command": "uvx",
"args": ["--from", "bibli", "bible", "mcp-server"]
}
}
}
```
### Testing the MCP Server
```bash
# Run the test script
uv run test_mcp.py
```
### Example Usage with MCP
Once connected to an AI application:
1. **Search verses**: "Find verses about love"
2. **Get explanations**: "Explain John 3:16 in detail"
3. **Bible study**: "Create a Bible study for Psalm 23"
4. **Cross-references**: "What verses relate to Romans 8:28?"
## Configuration
Configuration file: `~/.config/bible-cli/config.toml`
```toml
[general]
default_translation = "BBE"
theme = "dark"
page_size = 10
show_verse_numbers = true
[ascii_art]
enabled = true
style = "simple"
[mcp]
enabled = false
endpoint = "http://localhost:8000"
[keybindings]
next_verse = ["j", "down"]
prev_verse = ["k", "up"]
search = ["/"]
```
## Data Sources
The application automatically downloads Bible data from:
- Basic Bible English (BBE) translation from [Open Bibles](https://github.com/seven1m/open-bibles)
Additional translations can be imported from:
- JSON Bible files
- USFX XML format
- Custom API endpoints
## Development
### Setup Development Environment
```bash
git clone https://github.com/guzus/bible-cli
cd bible-cli
uv sync --extra dev
```
### Run Tests
```bash
uv run pytest
uv run pytest --cov=bibli
```
### Code Quality
```bash
uv run black bibli/
```
### Project Structure
```
bible-cli/
├── bibli/
│ ├── __init__.py # Package initialization
│ ├── __main__.py # Main entry point
│ ├── cli.py # Click command definitions
│ ├── tui.py # Textual TUI app
│ ├── models.py # SQLAlchemy models
│ ├── search.py # Search implementation
│ ├── mcp_server.py # FastAPI MCP server
│ ├── config.py # Configuration handling
│ ├── ascii_art.py # ASCII art constants
│ ├── data_import.py # Data import functionality
│ └── utils.py # Helper functions
├── tests/ # Test files
├── pyproject.toml # Project configuration
└── README.md # This file
```
## Examples
### Basic Usage
```bash
# Read John 3:16
uv run bible read john 3:16
# Read Genesis 1:1-10
uv run bible read genesis 1:1-10
# Search for verses about love
uv run bible search love --testament new
# Search with context
uv run bible search "faith without works" --context 2
# View database statistics
uv run bible info
```
### Advanced Search
```bash
# Exact phrase search
uv run bible search "in the beginning" --exact
# Case-sensitive search
uv run bible search "God" --case-sensitive
# Limit to specific book
uv run bible search faith --book james
# Limit results
uv run bible search love --limit 5
```
### Interactive Reading
```bash
# Read with interactive navigation
uv run bible read john 3:16 --interactive
# Navigate interactively from a specific verse
uv run bible nav john 3:16
# Read with context
uv run bible read john 3:16 --context 3
```
### Bookmarks and History
```bash
# Add bookmark
uv run bible bookmark add "john 3:16" --name "God's Love"
# List bookmarks
uv run bible bookmarks
# View reading history
uv run bible history --limit 10
```
## Contributing
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Run tests and linting
6. Submit a pull request
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgments
- Bible data from [Open Bibles](https://github.com/seven1m/open-bibles)
- Built with [Click](https://click.palletsprojects.com/), [Textual](https://textual.textualize.io/), and [Rich](https://rich.readthedocs.io/)
- Uses [UV](https://github.com/astral-sh/uv) for fast dependency management
- Inspired by the need for developer-friendly Bible study tools
## Support
- 🐛 [Report bugs](https://github.com/guzus/bible-cli/issues)
- 💡 [Request features](https://github.com/guzus/bible-cli/discussions)
- 📚 [Documentation](https://guzus.github.io/bible-cli/)
- 💬 [Community](https://github.com/guzus/bible-cli/discussions)
Raw data
{
"_id": null,
"home_page": null,
"name": "bibli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "bible, cli, religion, scripture, terminal",
"author": "guzus",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/77/92/713ac3563fcbfcaaf9e24693d9b401999d6eb8eb3485e3fd772de9f225e4/bibli-0.1.2.tar.gz",
"platform": null,
"description": "# Bible CLI\n\nA powerful command-line interface for Bible reading and study, designed specifically for programmers and terminal enthusiasts.\n\n## Features\n\n- \ud83d\udd0d **Fast Search** - Full-text search with regex support and context\n- \ud83d\udcd6 **Multiple Translations** - Support for various Bible translations\n- \ud83c\udfa8 **Rich Terminal UI** - Beautiful ASCII art and interactive TUI\n- \ud83d\udd16 **Bookmarks** - Save and organize your favorite verses\n- \ud83d\udcca **Reading History** - Track your Bible reading progress\n- \ud83d\udd27 **MCP Integration** - Model Context Protocol server for AI tools\n- \u2699\ufe0f **Customizable** - Extensive configuration options\n- \ud83c\udfaf **Developer-Friendly** - Designed with programmers in mind\n- \ud83d\udcc8 **Database Statistics** - View Bible database information and statistics\n\n## Installation\n\n### From PyPI (when published)\n\n```bash\npip install bibli\n# or\npipx install bibli\n```\n\n### From Source with UV (Recommended)\n\n```bash\ngit clone https://github.com/guzus/bible-cli\ncd bible-cli\nuv sync\n```\n\n### From Source with pip\n\n```bash\ngit clone https://github.com/guzus/bible-cli\ncd bible-cli\npip install -e .\n```\n\n## Quick Start\n\n```bash\n# Read a specific verse\nuv run bible read john 3:16\n\n# Read a range of verses\nuv run bible read genesis 1:1-5\n\n# Read an entire chapter\nuv run bible read psalms 23\n\n# Search for verses\nuv run bible search \"love your enemies\"\n\n# View database information\nuv run bible info\n\n# Interactive mode\nuv run bible\n\n# Get help\nuv run bible --help\n```\n\n## Commands\n\n### Information Commands\n\n- `bible info` - Display Bible database information and statistics with ASCII art\n\n### Reading Commands\n\n- `bible read <book> <chapter>:<verse>` - Read specific verse(s)\n- `bible goto <reference>` - Jump directly to a reference\n- `bible random` - Display a random verse\n- `bible daily` - Show verse of the day\n- `bible nav <book> <reference>` - Navigate Bible interactively\n\n### Search Commands\n\n- `bible search <query>` - Search for words or phrases\n - `--exact` - Exact phrase matching\n - `--case-sensitive` - Case-sensitive search\n - `--book <name>` - Limit search to specific book\n - `--testament <old|new>` - Limit to testament\n - `--context <n>` - Show n verses of context\n - `--limit <n>` - Maximum number of results\n\n### Bookmark Commands\n\n- `bible bookmarks` - List saved bookmarks\n- `bible bookmark add <reference>` - Add bookmark\n - `--name <name>` - Bookmark name\n - `--notes <notes>` - Bookmark notes\n- `bible history` - Show reading history\n\n### Interactive Mode\n\nLaunch the Terminal User Interface:\n\n```bash\nuv run bible interactive\n# or just\nuv run bible\n```\n\n#### Keyboard Shortcuts\n\n- `j/k` or `\u2193/\u2191` - Navigate verses\n- `h/l` or `\u2190/\u2192` - Previous/Next chapter\n- `Space/b` - Page down/up\n- `g` - Go to verse\n- `/` - Search mode\n- `r` - Random verse\n- `m` - Bookmark current verse\n- `?` - Help\n- `q` - Quit\n\n#### Interactive Reader Navigation\n\nWhen using `--interactive` flag with read commands:\n\n- `n` or `Enter` - Next verse\n- `p` - Previous verse\n- `N` - Next chapter\n- `P` - Previous chapter\n- `g` - Go to specific verse\n- `b` - Bookmark current verse\n- `q` - Quit\n\n## MCP Server\n\nThe Bible CLI includes a **Model Context Protocol (MCP) server** that allows AI applications like Claude to access Bible functionality directly.\n\n### Starting the MCP Server\n\n```bash\nuv run bibli mcp-server\n```\n\nThe server runs using stdio transport and can be connected to by MCP clients.\n\n### MCP Capabilities\n\n#### \ud83d\udd27 Tools (AI can call these functions)\n\n- **`search_verses`** - Search for Bible verses containing specific text\n- **`get_verse`** - Get a specific Bible verse by reference (e.g., \"John 3:16\")\n- **`get_chapter`** - Get all verses from a Bible chapter\n- **`get_random_verse`** - Get a random Bible verse\n- **`get_cross_references`** - Find related verses for cross-referencing\n\n#### \ud83d\udcda Resources (Contextual data for AI)\n\n- **`bible://books`** - List of all Bible books with metadata\n- **`bible://book/{book_name}`** - Information about a specific book\n\n#### \ud83d\udcad Prompts (Templates for Bible study)\n\n- **`bible-study`** - Generate comprehensive Bible study materials\n- **`verse-explanation`** - Provide detailed verse explanations and context\n- **`devotional`** - Create devotional reflections based on passages\n- **`sermon-outline`** - Generate sermon outlines from Bible texts\n\n### Connecting to Claude Desktop\n\nAdd to your `claude_desktop_config.json`:\n\n```json\n{\n \"mcpServers\": {\n \"bible-cli\": {\n \"command\": \"uvx\",\n \"args\": [\"--from\", \"bibli\", \"bible\", \"mcp-server\"]\n }\n }\n}\n```\n\n### Testing the MCP Server\n\n```bash\n# Run the test script\nuv run test_mcp.py\n```\n\n### Example Usage with MCP\n\nOnce connected to an AI application:\n\n1. **Search verses**: \"Find verses about love\"\n2. **Get explanations**: \"Explain John 3:16 in detail\"\n3. **Bible study**: \"Create a Bible study for Psalm 23\"\n4. **Cross-references**: \"What verses relate to Romans 8:28?\"\n\n## Configuration\n\nConfiguration file: `~/.config/bible-cli/config.toml`\n\n```toml\n[general]\ndefault_translation = \"BBE\"\ntheme = \"dark\"\npage_size = 10\nshow_verse_numbers = true\n\n[ascii_art]\nenabled = true\nstyle = \"simple\"\n\n[mcp]\nenabled = false\nendpoint = \"http://localhost:8000\"\n\n[keybindings]\nnext_verse = [\"j\", \"down\"]\nprev_verse = [\"k\", \"up\"]\nsearch = [\"/\"]\n```\n\n## Data Sources\n\nThe application automatically downloads Bible data from:\n\n- Basic Bible English (BBE) translation from [Open Bibles](https://github.com/seven1m/open-bibles)\n\nAdditional translations can be imported from:\n\n- JSON Bible files\n- USFX XML format\n- Custom API endpoints\n\n## Development\n\n### Setup Development Environment\n\n```bash\ngit clone https://github.com/guzus/bible-cli\ncd bible-cli\nuv sync --extra dev\n```\n\n### Run Tests\n\n```bash\nuv run pytest\nuv run pytest --cov=bibli\n```\n\n### Code Quality\n\n```bash\nuv run black bibli/\n```\n\n### Project Structure\n\n```\nbible-cli/\n\u251c\u2500\u2500 bibli/\n\u2502 \u251c\u2500\u2500 __init__.py # Package initialization\n\u2502 \u251c\u2500\u2500 __main__.py # Main entry point\n\u2502 \u251c\u2500\u2500 cli.py # Click command definitions\n\u2502 \u251c\u2500\u2500 tui.py # Textual TUI app\n\u2502 \u251c\u2500\u2500 models.py # SQLAlchemy models\n\u2502 \u251c\u2500\u2500 search.py # Search implementation\n\u2502 \u251c\u2500\u2500 mcp_server.py # FastAPI MCP server\n\u2502 \u251c\u2500\u2500 config.py # Configuration handling\n\u2502 \u251c\u2500\u2500 ascii_art.py # ASCII art constants\n\u2502 \u251c\u2500\u2500 data_import.py # Data import functionality\n\u2502 \u2514\u2500\u2500 utils.py # Helper functions\n\u251c\u2500\u2500 tests/ # Test files\n\u251c\u2500\u2500 pyproject.toml # Project configuration\n\u2514\u2500\u2500 README.md # This file\n```\n\n## Examples\n\n### Basic Usage\n\n```bash\n# Read John 3:16\nuv run bible read john 3:16\n\n# Read Genesis 1:1-10\nuv run bible read genesis 1:1-10\n\n# Search for verses about love\nuv run bible search love --testament new\n\n# Search with context\nuv run bible search \"faith without works\" --context 2\n\n# View database statistics\nuv run bible info\n```\n\n### Advanced Search\n\n```bash\n# Exact phrase search\nuv run bible search \"in the beginning\" --exact\n\n# Case-sensitive search\nuv run bible search \"God\" --case-sensitive\n\n# Limit to specific book\nuv run bible search faith --book james\n\n# Limit results\nuv run bible search love --limit 5\n```\n\n### Interactive Reading\n\n```bash\n# Read with interactive navigation\nuv run bible read john 3:16 --interactive\n\n# Navigate interactively from a specific verse\nuv run bible nav john 3:16\n\n# Read with context\nuv run bible read john 3:16 --context 3\n```\n\n### Bookmarks and History\n\n```bash\n# Add bookmark\nuv run bible bookmark add \"john 3:16\" --name \"God's Love\"\n\n# List bookmarks\nuv run bible bookmarks\n\n# View reading history\nuv run bible history --limit 10\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests\n5. Run tests and linting\n6. Submit a pull request\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Acknowledgments\n\n- Bible data from [Open Bibles](https://github.com/seven1m/open-bibles)\n- Built with [Click](https://click.palletsprojects.com/), [Textual](https://textual.textualize.io/), and [Rich](https://rich.readthedocs.io/)\n- Uses [UV](https://github.com/astral-sh/uv) for fast dependency management\n- Inspired by the need for developer-friendly Bible study tools\n\n## Support\n\n- \ud83d\udc1b [Report bugs](https://github.com/guzus/bible-cli/issues)\n- \ud83d\udca1 [Request features](https://github.com/guzus/bible-cli/discussions)\n- \ud83d\udcda [Documentation](https://guzus.github.io/bible-cli/)\n- \ud83d\udcac [Community](https://github.com/guzus/bible-cli/discussions)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line interface Bible application for programmers",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [
"bible",
" cli",
" religion",
" scripture",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2593b4bbaacdefeff2ad4be873685e86277493ef4c3c24d2f429c3c7ba3858ff",
"md5": "36578218e4d7226f0ca2c70f4a5722f6",
"sha256": "1208513878af7c5c40a271024f9a246150faef4301202576bef7f6a1347de8b3"
},
"downloads": -1,
"filename": "bibli-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36578218e4d7226f0ca2c70f4a5722f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 1321013,
"upload_time": "2025-07-08T17:30:52",
"upload_time_iso_8601": "2025-07-08T17:30:52.065641Z",
"url": "https://files.pythonhosted.org/packages/25/93/b4bbaacdefeff2ad4be873685e86277493ef4c3c24d2f429c3c7ba3858ff/bibli-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7792713ac3563fcbfcaaf9e24693d9b401999d6eb8eb3485e3fd772de9f225e4",
"md5": "15219560ba9afb35c193d0dc9b1bea47",
"sha256": "c51951fa063f52ad215af8578243ea2bade9f5cb3f89de3b3585e56c6f2e9e58"
},
"downloads": -1,
"filename": "bibli-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "15219560ba9afb35c193d0dc9b1bea47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1391276,
"upload_time": "2025-07-08T17:30:53",
"upload_time_iso_8601": "2025-07-08T17:30:53.534357Z",
"url": "https://files.pythonhosted.org/packages/77/92/713ac3563fcbfcaaf9e24693d9b401999d6eb8eb3485e3fd772de9f225e4/bibli-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 17:30:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bibli"
}
