sahih-al-bukhari 3.1.1

Complete Sahih al-Bukhari — 7,277 hadiths with full Arabic text and English translations. Data loaded from CDN. CLI + Python library.

🕌 Sahih al-Bukhari

One repo · one dataset · two packages — npm and PyPI

📚 Complete Sahih al-Bukhari — 7,277 hadiths, full Arabic + English.
Tiny installs, data from CDN. CLI + Node.js + React/Vue + Python.

---

📂 Monorepo Structure

sahih-al-bukhari/
│
├── bin/
│   ├── bukhari.json        ← 🔑 SHARED — single source of truth for JS + Python
│   └── index.js            ← JS CLI entry
│
├── chapters/               ← 🔑 SHARED — generated by `node build.mjs`
│   ├── meta.json           │   used by CDN loader (JS browser) and Python CDN fallback
│   ├── 1.json              │
│   └── ...                 │
│
├── sahih_al_bukhari/       ← Python package
│   ├── __init__.py
│   ├── bukhari.py          ← reads bin/bukhari.json automatically
│   └── cli.py
│
├── index.js                ← JS ESM (browser-safe, class only)
├── index.cjs               ← JS CommonJS (Node, reads bin/bukhari.json)
├── index.node.js           ← JS Node ESM (reads bin/bukhari.json)
├── index.browser.js        ← JS browser (CDN, auto-generated)
├── index.d.ts              ← TypeScript definitions
├── build.mjs               ← generates chapters/ from bin/bukhari.json
│
├── package.json            ← npm config
├── pyproject.toml          ← Python/Poetry config
├── MANIFEST.in             ← Python sdist: include data, exclude JS files
├── .npmignore              ← npm publish: exclude Python files
└── .gitignore

---

🔑 Shared Data Files

File	Used by
bin/bukhari.json	JS (Node CJS/ESM CLI) + Python (auto-detected)
chapters/	JS browser (CDN fetch) + Python CDN fallback

You never need to duplicate or convert data. Both packages read the same file.

---

🚀 Installation

# JavaScript / Node.js
npm install sahih-al-bukhari

# Python
pip install sahih-al-bukhari

---

🟨 JavaScript Usage

// CommonJS
const bukhari = require('sahih-al-bukhari');

// ESM (Node)
import bukhari from 'sahih-al-bukhari';

bukhari.get(1)
bukhari.getByChapter(1)
bukhari.search('prayer')
bukhari.getRandom()
bukhari[0]
bukhari.length
bukhari.metadata
bukhari.chapters

React Hook

cd my-react-app
bukhari --react   # generates src/hooks/useBukhari.js

import { useBukhari } from '../hooks/useBukhari';

function HadithOfTheDay() {
  const bukhari = useBukhari();
  if (!bukhari) return <p>Loading...</p>;
  const h = bukhari.getRandom();
  return <p>{h.english.narrator}: {h.english.text}</p>;
}

---

🐍 Python Usage

API is identical to the npm package (same camelCase method names):

from sahih_al_bukhari import Bukhari

bukhari = Bukhari()   # auto-reads bin/bukhari.json if in monorepo, else CDN

bukhari.get(1)
bukhari.getByChapter(1)
bukhari.search("prayer")
bukhari.search("prayer", limit=5)
bukhari.getRandom()
bukhari[0]
bukhari.length
bukhari.metadata
bukhari.chapters

# Array-style methods
bukhari.find(lambda h: h.id == 23)
bukhari.filter(lambda h: h.chapterId == 1)
bukhari.map(lambda h: h.narrator)
bukhari.slice(0, 10)

Custom path

bukhari = Bukhari(data_path="/absolute/path/to/bukhari.json")

---

🖥️ CLI (works from both npm and pip)

bukhari 1
bukhari 2345 -a          # Arabic only
bukhari 2345 -b          # Arabic + English
bukhari --search "prayer"
bukhari --search "fasting" --all
bukhari --chapter 5
bukhari --random
bukhari --react          # (JS only) generates React hook

---

🔧 Development

git clone https://github.com/SENODROOM/sahih-al-bukhari.git
cd sahih-al-bukhari
npm install

# Regenerate chapters/ from bin/bukhari.json
node build.mjs

# Publish JS
npm publish

# Publish Python
pip install build twine
python -m build
python -m twine upload dist/*

---

📄 License

GNU Affero General Public License v3.0 (AGPL-3.0)