npm - isnady - Versions diffs - 0.1.5 → 0.1.7 - Mend

isnady 0.1.5 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -1,612 +1,612 @@
-<!-- generated from README.md by tools/sync_readme.py — edit README.md, not this file -->
-<h1 align="center">📜 isnady &nbsp;<sub>إسناد</sub></h1>
-<p align="center">
-  <strong>Hadith search built around the isnad, the chain of transmission</strong><br>
-  <sub>Search the collections, read every chain narrator by narrator, and see how the scholars read it</sub>
-</p>
-<p align="center">
-  <a href="https://pypi.org/project/isnady/">
-    <img src="https://img.shields.io/badge/PyPI-v0.1.5-1D4777?style=for-the-badge&logo=pypi&logoColor=white" alt="PyPI">
-  </a>
-  <img src="https://img.shields.io/pypi/pyversions/isnady?style=for-the-badge&color=A47E24&logo=python&logoColor=white" alt="Python">
-  <img src="https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS-5B6878?style=for-the-badge" alt="Platform">
-  <a href="https://www.npmjs.com/package/isnady">
-    <img src="https://img.shields.io/badge/npm-v0.1.5-14304F?style=for-the-badge&logo=npm" alt="npm">
-  </a>
-  <img src="https://img.shields.io/badge/License-MIT-D6B25E?style=for-the-badge" alt="License">
-</p>
-<p align="center">
-  <a href="#-why-isnady">Why</a> •
-  <a href="#-install">Install</a> •
-  <a href="#-quick-start">Quick Start</a> •
-  <a href="#-search">Search</a> •
-  <a href="#-narrators">Narrators</a> •
-  <a href="#-hadith-scholars">Scholars</a> •
-  <a href="#-books">Books</a> •
-  <a href="#-shia-rijal">Shia Rijal</a> •
-  <a href="#-statistics">Statistics</a> •
-  <a href="#-learn">Learn</a> •
-  <a href="#-search-by-meaning-ai">Meaning (AI)</a> •
-  <a href="#-chains-of-transmission">Chains</a> •
-  <a href="#-educational-by-design">Educational</a> •
-  <a href="#-appearance">Appearance</a> •
-  <a href="#-data-and-licences">Data</a> •
-  <a href="#%EF%B8%8F-cli">CLI</a> •
-  <a href="#-screenshots">Screenshots</a> •
-  <a href="#%EF%B8%8F-roadmap">Roadmap</a>
-</p>
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/search-arabic.png" alt="Searching النيات finds بالنيات in Sahih al-Bukhari 1, with the chain above the text" width="850">
-</p>
-> **Pre-alpha (0.1.5).** Search and chains of transmission work today, on data you import
-> in one command. Narrators, scholars, gradings and the rest are being built, in the open.
----
-> **About this npm package.** `npm install isnady` installs a small JavaScript library that will grow into
-> isnady's API for the web (isnady.net); it does **not** install the isnady application. The application is
-> installed with Python (`pip install isnady`, or the one-line installers below) or downloaded as a desktop
-> app from the [GitHub Releases](https://github.com/bayramkotan/isnady/releases/latest) page. The npm package
-> always carries the same version number as the application.
->
-> ```js
-> import { info, version } from "isnady";
-> console.log(version);      // the isnady version, the same as on PyPI and GitHub
-> console.log(info());       // { name, version, dataLoaded, homepage }
-> ```
-## 🎯 Why isnady
-A hadith is two things: the text (*matn*) and the chain of people who passed it on
-(*isnad*). Most hadith sites let you search the text and show a grade. isnady is built
-the other way round: the chain comes first, because that is where the scholars of hadith
-did their work.
-- **The chain is read, not typed in.** isnady reads the chain from the Arabic text itself:
-  who narrated to whom, with which words, and whether it reaches the Prophet.
-- **Nothing is guessed.** Where the wording cannot be read with confidence, the chain is
-  kept whole and marked, never split wrongly. A missing link is shown as missing.
-- **Every fact has a source.** Every hadith, text and grade records where it came from,
-  under which licence.
-- **Grades are shown as the scholars gave them.** Each grade keeps its scholar's name and
-  wording; isnady does not merge them or invent its own.
-- **Window and command line, same engine.** Everything the window does, the command line
-  does too, with the same results.
----
-## 📦 Install
-### Desktop application
-Download isnady for your system from the **[latest release](https://github.com/bayramkotan/isnady/releases/latest)** —
-everything included, the AI features too:
-| System | File |
-|---|---|
-| Windows 10/11 | `isnady-<version>-windows-portable.exe` — Windows may say the publisher is unknown (the app is not signed): *More info → Run anyway* |
-| Linux | `isnady-<version>-linux-x86_64.AppImage` — make it executable (`chmod +x`) and run it |
-| macOS, Apple silicon / Intel | `isnady-<version>-macos-arm64.zip` / `…-macos-x86_64.zip` — unzip and run `isnady.app`; the first time, right-click it and choose *Open* (it is not notarized) |
-All three are **portable**: nothing is installed, each runs from wherever it is. Put a folder named
-`isnady-data` beside the file and isnady keeps its databases and settings there — isnady on a USB stick.
-Put isnady on the desktop and in the applications menu with **Tools → Create Desktop Shortcut** (or
-`iy shortcut`): the shortcut starts isnady the way it is installed — the AppImage, the application, or the
-`isnady-gui` command of a Python install.
-### With Python
-One line, on any system. Install isnady wherever you like — for all users, for yourself, in a
-virtual environment, with pipx: the same line installs it, and later updates every copy where it
-is, asking for administrator rights only when a copy needs them. Nothing is ever removed.
-```bash
-# Linux and macOS
-curl -fsSL https://raw.githubusercontent.com/bayramkotan/isnady/main/install.sh | bash
-```
-```powershell
-# Windows (PowerShell)
-irm https://raw.githubusercontent.com/bayramkotan/isnady/main/install.ps1 | iex
-```
-Or with pip:
-```bash
-pip install isnady
-isnady            # or the short name:  iy
-```
-Run inside a clone of this repository, the installer makes an editable (developer) install of
-that clone instead.
-The same program answers to several names: **`iy`** to type, **`isnady`** to read, and
-`isnady-cli` kept from the first releases. Without arguments it opens the window; with
-arguments it is the command line. On Windows, **`isnady-gui`** opens the window without a
-console.
-<details>
-<summary><b>🐧 On Linux, pip may refuse to install</b></summary>
-<br>
-Most current distributions mark the system Python as *externally managed* (PEP 668), so a
-plain `pip install` stops with `error: externally-managed-environment`. Two ways around it:
-```bash
-# Isolated — recommended, no system packages touched
-pipx install isnady
-# Into your user site — needs the override flag
-pip install isnady --break-system-packages --no-cache-dir -U
-```
-</details>
-### Something not right?
-`iy update` updates every copy of isnady where it is installed. `iy doctor` lists every copy and
-which one each command really starts — an older copy in the user folder can start before a newer
-one elsewhere, so every copy is kept at the same version. The same report is under
-**Help → Check Installation**. If an old copy starts even for `iy update`, run
-`python3 -s -m isnady update` (Windows: `py -s -m isnady update`).
-### Upgrading
-```bash
-iy update
-```
-Your data stays where it is; a newer isnady upgrades the database in place the first time
-it opens it.
----
-## 🚀 Quick Start
-isnady ships without hadith data: you choose the sources. One command brings in Sahih
-al-Bukhari and Sunan Abi Dawud in Arabic and Turkish from the open
-[fawazahmed0/hadith-api](https://github.com/fawazahmed0/hadith-api) collection (public
-domain):
-```bash
-iy import fawazahmed0 https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.json \
-   --book bukhari --book abudawud --language ara --language tur --license Unlicense
-```
-Or open the window with `iy` and choose **File → Data Sources**: every built-in collection
-(al-Bukhari, Muslim, Abu Dawud, al-Tirmidhi, al-Nasa'i, Ibn Maja, the Muwatta and three
-forty-hadith books) and the Taqrib import with one click — or **Import all** — in the
-languages you tick. You can add your own files or links there too, and move the data
-folder anywhere you like.
-On the command line:
-```bash
-iy search النيات            # Arabic, with or without diacritics
-iy search "niyetlere göre"   # Turkish, English, any imported language
-iy chain bukhari 1           # one chain, narrator by narrator
-```
-Importing takes a minute or two; the search index and the chains are built as part of it.
-To identify the narrators in those chains, add Ibn Hajar's *Taqrib al-Tahdhib* — 8,824
-narrators with his verdict on each — from the [OpenITI](https://github.com/OpenITI) corpus:
-```bash
-iy import taqrib https://raw.githubusercontent.com/OpenITI/0875AH/master/data/0852IbnHajarCasqalani/0852IbnHajarCasqalani.TaqribTahdhib/0852IbnHajarCasqalani.TaqribTahdhib.JK000121-ara1.completed
-iy narrator الزهري
-```
----
-## 🔎 Search
-| | |
-|:--|:--|
-| **Arabic without diacritics** | `الاعمال` finds `الأَعْمَالُ`. Alef forms, alef maqsura, hamza seats and ta marbuta are treated alike, so you type the way you normally write |
-| **Attached prefixes** | `النيات` finds `بالنيات`, because Arabic joins bi-, wa-, fa- and al- to the word. *Whole words only* turns this off |
-| **Latin-script text** | Case and accents are ignored: `NIYET`, `niyet` and `nîyet` are one word; `Muʿādh`, `Mu'adh` and `Muadh` too |
-| **Match** | All words, any word, or the exact phrase |
-| **Filters** | Book and language; the language filter also chooses which translations appear |
-| **Grades** | Shown under each hadith with the scholar's name, exactly as given |
-| **Highlighting** | On the original, diacritised text, diacritics included |
-Results appear at once and fill in as you read; the window never waits for them.
-### 👥 Narrators
-The **Narrators** page lists every narrator of the imported rijal work — 8,824 from Ibn
-Hajar's *Taqrib* — searchable in Arabic or in Latin letters (`Abu Hurayra`, `Zuhri`, `Ibn Umar`),
-and filtered by tabaqa, rank and book. For each narrator: Ibn Hajar's verdict and its rank, the
-tabaqa and death year, the books his hadith appear in, **whom he narrates from and who
-narrates from him** in the imported chains, the compilers who narrate from him directly, and
-every hadith whose chain includes him. On the Isnad Chains page a click on a narrator's name
-opens him here.
-Each narrator — and each scholar — is shown by the name he is **known by** (al-A'mash, Ibn 'Umar,
-Abu Hurayra), with his full name and every part of it laid out: name, lineage, kunya, by-name,
-nisbas, client of; the part he is known by is marked ★.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/narrators.png" alt="Narrators — 'Abdullah b. 'Umar: Ibn Hajar's verdict, tabaqa, death year, teachers and students in the chains" width="850">
-</p>
-### 🎓 Hadith Scholars
-The scholars whose work is in the imported data, and what the data measures of it:
-**compilers** (their collection, the teachers their chains begin with, the Companions they end
-with), **graders** (how they grade, and how far they agree with each other on the same hadith —
-agreement, Cohen's kappa, and a strictness index: the classical *mutashaddid* / *mutasahil*,
-measured), and **critics** of narrators (Ibn Hajar's twelve ranks). On Sunan Abi Dawud, for
-example, Zubair 'Ali Za'i grades most strictly (−0.21) and agrees with al-Albani on 70% of the
-hadith; the page also flags a pair of graders whose 98% agreement suggests the source did not keep
-them independent.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/scholars.png" alt="Hadith Scholars — al-Albani: his grades on Sunan Abi Dawud and his agreement with the other graders" width="850">
-</p>
-### 📚 Books
-isnady is not only for searching: the **Books** section opens every imported work and reads it in
-its own order. A hadith collection reads chapter by chapter, each hadith with its card (chain,
-narrators, other narrations, grades) and the languages you choose; Ibn Hajar's *Taqrib* reads
-letter by letter and name by name, each entry with its narrator a click away. Find within a
-chapter, go to the previous or next one, and isnady remembers where you were. From any search
-result, **In its book** opens the hadith where it stands, among the hadith of its chapter.
-Books are not tied to hadith collections: a work is a tree of any depth (volume, book, chapter,
-section) whose leaves are hadith, narrators' entries or paragraphs — so the commentaries, manuals
-of fiqh and other works of the scholars can be read the same way as they are added.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/books.png" alt="Books — reading Sahih al-Bukhari chapter by chapter, Arabic and Turkish, each hadith with its chain" width="850">
-</p>
-```bash
-iy book                      # the books
-iy book bukhari              # its chapters
-iy book bukhari 2 --language Turkish
-iy book taqrib 1
-```
-### 🕌 Shia Rijal
-The Imami tradition's judgments on narrators, on its own terms: al-Najashi's *Rijal* — 1,266
-authors and narrators — read along the two axes of the Imami critics, **reliability** (thiqa;
-praised — *jalil*, *wajh*, *'ayn*; weak) and **creed** (Imami, or Waqifi, Fathi, Zaydi, *'ammi* …),
-which together give the classical four: an Imami *thiqa*, a praised narrator (*mamduh*), a *thiqa*
-of another school (*muwaththaq*), a weak one. The critic's own words are always shown; a creed he
-does not state stays unknown; nothing is mapped onto Ibn Hajar's twelve ranks. Checked on four
-blind samples of entries, each round's misses corrected. The book itself reads in **Books**, and
-the Shia narrators are kept apart from the (Sunni) chains: no chain link is matched to them.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/shia-rijal.png" alt="Shia Rijal — al-Najashi on 'Ali b. al-Husayn b. Babawayh: his words and their reading on the Imami scale" width="850">
-</p>
-Next: al-Tusi's *Rijal* and *Fihrist*, al-'Allama al-Hilli's *Khulasat al-aqwal*, Ibn Dawud's
-*Rijal*, al-Kashshi's reports, and the Four Books with their chains.
-### 📊 Statistics
-Measured in depth, each figure with what it means and how sure it is. Grades are ordered
-categories, so they are never turned into numbers or averaged. The first tab, **Graders**, takes
-the scholars who graded a book (al-Albani, Shu'ayb al-Arna'ut, Zubair 'Ali Za'i, Muhammad Muhyi
-al-Din 'Abd al-Hamid on Sunan Abi Dawud) and shows:
-- agreement of every pair — same grade, Cohen's kappa and the ordinal kappa — with 95% intervals,
-  and Krippendorff's alpha for all of them together;
-- a **Dawid–Skene model** of each hadith's true grade: each grader's confusion matrix (how he grades
-  a hadith of each true grade) and, for every hadith, how sure the model is;
-- **strictness** — the classical *mutashaddid* and *mutasahil*, measured by order only, with intervals;
-- the **disputed hadith**, where the scholars are furthest apart — a double-click opens one in its book.
-Two graders who agree far too often to be independent (98.1%) count as one voice in the model,
-and the page says so. Results are computed once and kept in a file. `iy stats graders`.
-Narrators, books, hadith, chains, correlations and the models follow, tab by tab.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/statistics.png" alt="Statistics — the graders of Sunan Abi Dawud: Krippendorff's alpha, agreement with intervals, the model's certainty" width="850">
-</p>
-### 🎓 Learn
-The terms of hadith and its sciences, written for isnady with their classical sources: 81 terms —
-the grades (sahih, hasan, da'if, mawdu', shadhdh, munkar, mu'allal), the kinds of hadith by their
-chain (mutawatir, mursal, munqati', mu'allaq, mudallas …), chain and text (mutaba'a, shahid,
-takhrij, madar), the ways of receiving (sama', ijaza, haddathana, 'an), judging narrators (the
-twelve ranks of Ibn Hajar, thiqa, saduq, majhul, matruk, mudallis), generations, the parts of an
-Arabic name, Imami rijal, the books, and isnady's own measures. Each with its Arabic, a one-line
-and a longer definition in **English or Turkish**, related terms one click away, and its source.
-The grades on every result explain themselves when you point at them. `iy term mursal --lang tr`.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/learn.png" alt="Learn — the term mursal: Arabic, definition, related terms and source" width="850">
-</p>
-### 🧠 Search by meaning (AI)
-Choose **Match → By meaning (AI)** to find hadith that say the same thing in other words or in
-another language: `komşu hakları` finds the hadith on the neighbour's rights, a Turkish sentence
-finds its Arabic original, and `إنما الأعمال بالنيات` gathers the narrations of the hadith on
-intentions from every imported book. Each result shows how close it is in meaning (0–1), which
-says nothing about authenticity.
-The model is learnt on your computer from the texts you imported — Arabic beside its
-translations is a parallel corpus, and cross-lingual latent semantic analysis learns the
-concepts the languages share. Nothing is downloaded and no outside model is used. Measured on
-al-Bukhari and Abu Dawud: for hadith the model never saw while learning, a Turkish translation
-finds its Arabic original first 68% of the time and among the first ten 93% of the time (chance:
-0.8%). For an exact quotation the ordinary word search stays the better tool.
-The same step finds the **other narrations of each hadith** across the imported books
-(takhrij): every result card says where else it is narrated — *Also narrated in: Sahih
-al-Bukhari 5070 · 6689 · 6953 | Sunan Abi Dawud 2201* — and each number opens that hadith.
-Only the texts are compared, never the chains; upright numbers share the text, italic ones
-probably report the same event from the same Companion. In blind, hand-checked samples 34 of
-35 pairs of the first kind and 18 of 20 of the second were right.
-```bash
-pip install "isnady[ai]"        # numpy and scipy
-iy ai build                     # a few seconds; or Tools → Build AI Indexes
-iy search --mode meaning "komşu hakları"
-iy tahric bukhari 1             # the other narrations of a hadith
-```
----
-## 🔗 Chains of transmission
-Every Arabic text is read for its chain:
-```
-Sahih al Bukhari 1
-   1. حدثنا (narrated to us)  الْحُمَيْدِيُّ عَبْدُ اللَّهِ بْنُ الزُّبَيْرِ
-   2. حدثنا (narrated to us)  سُفْيَانُ
-   3. حدثنا (narrated to us)  يَحْيَى بْنُ سَعِيدٍ الْأَنْصَارِيُّ
-   4. أخبرني (informed me)    مُحَمَّدُ بْنُ إِبْرَاهِيمَ التَّيْمِيُّ
-   5. سمع (heard)            عَلْقَمَةَ بْنَ وَقَّاصٍ اللَّيْثِيَّ
-   6. سمعت (I heard)          عُمَرَ بْنَ الْخَطَّابِ
-      -> the Prophet
-```
-In the window, each result shows its chain as a row of names ending at the Prophet, and
-**View chain** opens it as a timeline from the book to the Prophet, with the Arabic text
-below: the chain in lighter ink, the text of the hadith in full ink.
-### 👤 Who each narrator is
-With Ibn Hajar's *Taqrib al-Tahdhib* imported, every name in a chain is matched to a
-narrator, and the chain shows what Ibn Hajar says of him: his verdict in his own words, its
-rank on Ibn Hajar's twelve-step scale, the narrator's *tabaqa* (generation) and his death
-year.
-A name is linked only when the evidence leaves one person: the words of the name, the book
-marks (a narrator in al-Bukhari must be one Ibn Hajar marks خ), the order of generations
-along the chain, and the last link before the Prophet being a Companion. When several
-narrators remain — "Sufyan" can be al-Thawri or Ibn 'Uyayna — the chain says so and names
-how many, rather than choosing one. Today about half of all names are identified; in blind,
-hand-checked samples of the identified ones, the last fifty were all correct.
-Names are kept exactly as written, with the clarifications the compilers added
-(*"— yaʿnī Ibn Muḥammad —"*, *"mawlā Ibn ʿAbbās"*), because identifying each narrator is
-a separate step that comes next.
-<details>
-<summary><b>📊 How well it reads today</b></summary>
-<br>
-Measured on Sahih al-Bukhari and Sunan Abi Dawud (12,852 chains):
-| | Bukhari | Abu Dawud | Both |
-|:--|:--:|:--:|:--:|
-| Split into narrators | 85.5% | 71.9% | 79.9% |
-| Of those, reaching the Prophet | | | 78.3% |
-| Narrators per chain | | | 5.0 |
-In a blind, hand-checked sample of 30 chains: **no wrong narrator**, 27 complete.
-The rest are kept whole, each with its reason: *tahwil* (ح, a second chain joining), two
-teachers at one link (*qiran*), a second chain after the first, or wording that could not be
-read with confidence. Abu Dawud uses *qiran* and *tahwil* far more often than Bukhari, which
-is why its share is lower. One known limit: a last narrator introduced only by *qāla*
-("قال قال عبد الله") is not added, because the same words also begin stories.
-</details>
----
-## 🎓 Educational by Design
-isnady teaches the science it uses. Every transmission term in a chain explains itself:
-| Term | Reads | What the critics took it to mean |
-|:--:|:--|:--|
-| حدثنا | narrated to us | The teacher recited it to a group: heard directly |
-| حدثني | narrated to me | Recited to the narrator alone: heard directly |
-| أخبرنا | informed us | Often a text read back to the teacher (*ʿarḍ*) |
-| أنبأنا | told us | Later often transmission by permission (*ijāza*) |
-| سمعت | I heard | Direct hearing, stated explicitly |
-| قرأت على | I read to | The narrator read the text back to the teacher |
-| عن | from | Does not say how it was received (*ʿanʿana*); connected when the two could have met and the narrator is not known for *tadlīs* |
-| أن | that | Treated by most critics like ʿan (*muʾannan*) |
-The Learn section — hadith terminology, grading, *jarḥ wa taʿdīl* and the classical works,
-each shown on real hadith and real chains — is on the roadmap.
----
-## 🎨 Appearance
-Seven themes, chosen in **Edit → Preferences → Themes** — each shown as a small live isnady window —
-or in **View → Theme**: *Lapis* (lapis and gold of illuminated manuscripts) and *Lapis Night*, which
-"Follow system" switches between; *Paper* (warm cream and ink, for long reading); *Slate* (quiet and
-modern, with a light sidebar); *Emerald*; *Midnight* (deep dark with teal); and *High Contrast*
-(black, white and yellow, for low vision). `iy config set view.theme paper`.
-Every script has its own reading font, size, colour and line spacing — Arabic, Latin,
-Cyrillic, Bengali and Tamil today, more as sources in other scripts arrive. The light and
-the dark theme each keep their own colours, and the interface font can be changed too.
-**Edit → Preferences** (Ctrl + ,) applies every change at once; each row has its own
-Default button.
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/preferences.png" alt="Preferences — font, size, line spacing and colour for each script" width="760">
-</p>
-The same settings from the command line:
-```bash
-iy config list --prefix text.arabic       # what is set, and what is changed
-iy config set text.arabic.size 22
-iy config set text.latin.family "Noto Serif"
-iy config set colors.dark.gilt "#5A4A1E"  # matched words in the dark theme
-iy config reset text.arabic               # back to the defaults
-```
-Settings live in `settings.json` in the isnady data folder, shared by the window and the
-command line.
----
-## 📚 Data and licences
-isnady reads open formats and keeps the source of everything:
-- **Supported now:** the [fawazahmed0/hadith-api](https://github.com/fawazahmed0/hadith-api)
-  JSON format, from a file or a URL, with or without authentication (username and
-  password, bearer token, or API key; credentials are never stored).
-- **Rijal:** Ibn Hajar's *Taqrib al-Tahdhib* in OpenITI mARkdown — each narrator's name,
-  kunya, verdict, rank, tabaqa, death year and book marks, read by the rules Ibn Hajar sets
-  out in his own introduction. The OpenITI release does not state its licence in the
-  repository, so it is kept as tier C (used on your computer, never redistributed) until
-  it is confirmed.
-- **Coming:** CSV, SQL/SQLite, OpenITI mARkdown, REST APIs and Shamela, so any collection
-  you have can be brought in.
-Every source records a licence **tier**: **A** may be redistributed, **B** may be
-redistributed under its conditions, **C** may not. Sources you add yourself stay on your
-computer. **Help → Licences** lists every source in your database with its licence.
----
-## ⌨️ CLI
-Everything the window does also works without it — on a server, over SSH, or in a
-script. The command line never loads Qt.
-| Short | Full | What it does |
-|:------|:-----|:-------------|
-| `iy` | `isnady` | Open the window |
-| `iy search WORDS` | `isnady search WORDS` | Search; `--mode all\|any\|phrase`, `--whole-words`, `--book`, `--language`, `--limit` |
-| `iy chain BOOK NUMBER` | `isnady chain bukhari 1` | One chain, narrator by narrator, with who each one is; `--raw` adds the wording |
-| `iy isnads` | `isnady isnads` | Read every chain and report per book; `--rebuild` reads them again |
-| `iy ai build` | `isnady ai build` | Learn the meaning index from the imported texts (`iy ai status` to check) |
-| `iy import najashi FILE` | `isnady catalog import najashi` | al-Najashi's Rijal: Shia narrators read on the Imami scale, and the book |
-| `iy shortcut` | `isnady shortcut --no-desktop` | A desktop and applications-menu shortcut, with isnady's icon |
-| `iy term [NAME]` | `isnady term --search tadlis` | The glossary: a term's meaning, English or Turkish (`--lang tr`) |
-| `iy stats graders` | `isnady stats graders --book abudawud` | The graders of a book in depth: agreement, model, strictness |
-| `iy book [KEY [CHAPTER]]` | `isnady book bukhari 2` | The books; a book's chapters; a chapter read in order |
-| `iy scholar [NAME]` | `isnady scholar albani` | The scholars in the data, or one of them with his measured statistics |
-| `iy tahric BOOK NUMBER` | `isnady tahric bukhari 1` | Other narrations of a hadith in the imported books (takhrij) |
-| `iy search --mode meaning WORDS` | `isnady search --mode meaning "komşu hakları"` | Search by meaning and across languages |
-| `iy narrator NAME` | `isnady narrator "Ibn Umar"` | A narrator: Ibn Hajar's verdict and rank, tabaqa, death year, books, other names; with `--limit 1` also teachers, students and hadith |
-| `iy import FORMAT FILE-OR-URL` | `isnady import …` | Import a source; `--book`, `--language`, `--license`, `--user`, `--token-env`, `--api-key-env` |
-| `iy catalog list` | `isnady catalog list` | Built-in sources and your own, with what is imported — the same as File → Data Sources |
-| `iy catalog import ID` | `isnady catalog import fawaz-muslim --language tur` | Import a listed source; `remove`, `add`, `delete` manage the list |
-| `iy catalog import --all` | `isnady catalog import --all --language ara` | Every built-in source at once |
-| `iy datadir [FOLDER]` | `isnady datadir /data/isnady` | Show or change where the database and settings live; `--as-is`, `--default` |
-| `iy formats` | `isnady formats` | Formats that can be imported |
-| `iy sources` | `isnady sources` | Imported sources, their licence and tier |
-| `iy stats` | `isnady stats` | Hadith, texts, grades and chains per book |
-| `iy remove KEY` | `isnady remove KEY` | Remove a source and everything imported from it |
-| `iy config list\|get\|set\|reset` | `isnady config …` | Appearance and other settings — the same as Edit → Preferences |
-| `iy update` | `isnady update` | Update every copy of isnady where it is installed (system, user, venv, pipx, clone) |
-| `iy doctor` | `isnady doctor` | Every copy of isnady on this computer and which one each command starts |
-| `iy -V` | `isnady -V` | Show the version (also `-v`, `--version`, `version`) |
-| `iy -h` | `isnady -h` | Show help |
-```console
-$ iy search niyet --book abudawud --limit 1
-43 hadith found in 8 ms
-Sunan Abu Dawud #472
-  grades: Al-Albani: Hasan; Muhammad Muhyi Al-Din Abdul Hamid: Hasan; Shuaib Al Arnaut: Daif; Zubair Ali Zai: Daif
-  [Turkish] Ebu Hureyre (r.a.); Resulullah (Sallallahu aleyhi ve Sellem)'in şöyle buyurduğunu rivayet etmiştir: "Bir kimse mescid'e hangi [niyet]le gelirse nasibi ondan ibarettir"
-```
----
-## 📸 Screenshots
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chain.png" alt="Isnad Chains — the chain of Sahih al-Bukhari 1 as a timeline from the book to the Prophet" width="850">
-</p>
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/search-grades.png" alt="Search — Sunan Abi Dawud with each scholar's grade and the chain above the text" width="850">
-</p>
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chain-dark.png" alt="Dark theme — a seven-narrator chain from Sunan Abi Dawud" width="850">
-</p>
-<p align="center">
-  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chains-overview.png" alt="Chains overview — per-book statistics and what was kept whole" width="850">
-</p>
----
-## 🗺️ Roadmap
-- **Narrators** — the other half of the names identified through teachers and students
-  (al-Mizzi's *Tahdhib al-Kamal*), the verdicts of other critics beside Ibn Hajar's, and
-  whether each link could have met the next.
-- **Hadith scholars** — their lives in full, and more scholars as more collections and grades
-  are imported.
-- **Shia rijal** — narrator verdicts from the Shia rijal works, beside the Sunni view.
-- **Learn** — the sciences of hadith, shown on real hadith and real chains.
-- **More sources and formats** — and adding your own from inside the window.
-- **Glossary** — every Arabic term of hadith and the Islamic sciences explained where it
-  appears: hover or click a term, read its meaning in the interface language.
-- **isnady.net** — the same engine on the web.
----
-## 🔁 Versions and releases
-One version number on GitHub, PyPI and npm, always. A release builds the Python package and the Windows,
-Linux and macOS applications first; only when every build succeeds is anything published — PyPI, then the
-[GitHub Release](https://github.com/bayramkotan/isnady/releases) with every file and its checksum. What each
-version brought is in the [CHANGELOG](https://github.com/bayramkotan/isnady/blob/main/CHANGELOG.md). The
-README on npm is made from this one.
-## 🏗️ Build from Source
-```bash
-git clone https://github.com/bayramkotan/isnady.git
-cd isnady
-pip install -e .
-iy
-```
-Python 3.10 or newer and PySide6. The command line alone needs no PySide6.
----
-The desktop application of your own system: `pip install ".[ai]" pyinstaller`, then
-`python packaging/build_app.py linux|windows|macos VERSION`.
-## 📝 License
-MIT for the application code. Hadith data comes from separate sources, each under its own
-licence, recorded with the data and listed under **Help → Licences**.
-The Arabic and reading typeface is [Amiri](https://github.com/aliftype/amiri) by Khaled
-Hosny, bundled under the SIL Open Font License 1.1 (`src/isnady/assets/fonts/OFL.txt`).
+<!-- generated from README.md by tools/sync_readme.py — edit README.md, not this file -->
+<h1 align="center">📜 isnady &nbsp;<sub>إسناد</sub></h1>
+<p align="center">
+  <strong>Hadith search built around the isnad, the chain of transmission</strong><br>
+  <sub>Search the collections, read every chain narrator by narrator, and see how the scholars read it</sub>
+</p>
+<p align="center">
+  <a href="https://pypi.org/project/isnady/">
+    <img src="https://img.shields.io/badge/PyPI-v0.1.7-1D4777?style=for-the-badge&logo=pypi&logoColor=white" alt="PyPI">
+  </a>
+  <img src="https://img.shields.io/pypi/pyversions/isnady?style=for-the-badge&color=A47E24&logo=python&logoColor=white" alt="Python">
+  <img src="https://img.shields.io/badge/Platform-Windows%20%7C%20Linux%20%7C%20macOS-5B6878?style=for-the-badge" alt="Platform">
+  <a href="https://www.npmjs.com/package/isnady">
+    <img src="https://img.shields.io/badge/npm-v0.1.7-14304F?style=for-the-badge&logo=npm" alt="npm">
+  </a>
+  <img src="https://img.shields.io/badge/License-MIT-D6B25E?style=for-the-badge" alt="License">
+</p>
+<p align="center">
+  <a href="#-why-isnady">Why</a> •
+  <a href="#-install">Install</a> •
+  <a href="#-quick-start">Quick Start</a> •
+  <a href="#-search">Search</a> •
+  <a href="#-narrators">Narrators</a> •
+  <a href="#-hadith-scholars">Scholars</a> •
+  <a href="#-books">Books</a> •
+  <a href="#-shia-rijal">Shia Rijal</a> •
+  <a href="#-statistics">Statistics</a> •
+  <a href="#-learn">Learn</a> •
+  <a href="#-search-by-meaning-ai">Meaning (AI)</a> •
+  <a href="#-chains-of-transmission">Chains</a> •
+  <a href="#-educational-by-design">Educational</a> •
+  <a href="#-appearance">Appearance</a> •
+  <a href="#-data-and-licences">Data</a> •
+  <a href="#%EF%B8%8F-cli">CLI</a> •
+  <a href="#-screenshots">Screenshots</a> •
+  <a href="#%EF%B8%8F-roadmap">Roadmap</a>
+</p>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/search-arabic.png" alt="Searching النيات finds بالنيات in Sahih al-Bukhari 1, with the chain above the text" width="850">
+</p>
+> **Pre-alpha (0.1.7).** Search and chains of transmission work today, on data you import
+> in one command. Narrators, scholars, gradings and the rest are being built, in the open.
+---
+> **About this npm package.** `npm install isnady` installs a small JavaScript library that will grow into
+> isnady's API for the web (isnady.net); it does **not** install the isnady application. The application is
+> installed with Python (`pip install isnady`, or the one-line installers below) or downloaded as a desktop
+> app from the [GitHub Releases](https://github.com/bayramkotan/isnady/releases/latest) page. The npm package
+> always carries the same version number as the application.
+>
+> ```js
+> import { info, version } from "isnady";
+> console.log(version);      // the isnady version, the same as on PyPI and GitHub
+> console.log(info());       // { name, version, dataLoaded, homepage }
+> ```
+## 🎯 Why isnady
+A hadith is two things: the text (*matn*) and the chain of people who passed it on
+(*isnad*). Most hadith sites let you search the text and show a grade. isnady is built
+the other way round: the chain comes first, because that is where the scholars of hadith
+did their work.
+- **The chain is read, not typed in.** isnady reads the chain from the Arabic text itself:
+  who narrated to whom, with which words, and whether it reaches the Prophet.
+- **Nothing is guessed.** Where the wording cannot be read with confidence, the chain is
+  kept whole and marked, never split wrongly. A missing link is shown as missing.
+- **Every fact has a source.** Every hadith, text and grade records where it came from,
+  under which licence.
+- **Grades are shown as the scholars gave them.** Each grade keeps its scholar's name and
+  wording; isnady does not merge them or invent its own.
+- **Window and command line, same engine.** Everything the window does, the command line
+  does too, with the same results.
+---
+## 📦 Install
+### Desktop application
+Download isnady for your system from the **[latest release](https://github.com/bayramkotan/isnady/releases/latest)** —
+everything included, the AI features too:
+| System | File |
+|---|---|
+| Windows 10/11 | `isnady-<version>-windows-portable.exe` — Windows may say the publisher is unknown (the app is not signed): *More info → Run anyway* |
+| Linux | `isnady-<version>-linux-x86_64.AppImage` — make it executable (`chmod +x`) and run it |
+| macOS, Apple silicon / Intel | `isnady-<version>-macos-arm64.zip` / `…-macos-x86_64.zip` — unzip and run `isnady.app`; the first time, right-click it and choose *Open* (it is not notarized) |
+All three are **portable**: nothing is installed, each runs from wherever it is. Put a folder named
+`isnady-data` beside the file and isnady keeps its databases and settings there — isnady on a USB stick.
+Put isnady on the desktop and in the applications menu with **Tools → Create Desktop Shortcut** (or
+`iy shortcut`): the shortcut starts isnady the way it is installed — the AppImage, the application, or the
+`isnady-gui` command of a Python install.
+### With Python
+One line, on any system. Install isnady wherever you like — for all users, for yourself, in a
+virtual environment, with pipx: the same line installs it, and later updates every copy where it
+is, asking for administrator rights only when a copy needs them. Nothing is ever removed.
+```bash
+# Linux and macOS
+curl -fsSL https://raw.githubusercontent.com/bayramkotan/isnady/main/install.sh | bash
+```
+```powershell
+# Windows (PowerShell)
+irm https://raw.githubusercontent.com/bayramkotan/isnady/main/install.ps1 | iex
+```
+Or with pip:
+```bash
+pip install isnady
+isnady            # or the short name:  iy
+```
+Run inside a clone of this repository, the installer makes an editable (developer) install of
+that clone instead.
+The same program answers to several names: **`iy`** to type, **`isnady`** to read, and
+`isnady-cli` kept from the first releases. Without arguments it opens the window; with
+arguments it is the command line. On Windows, **`isnady-gui`** opens the window without a
+console.
+<details>
+<summary><b>🐧 On Linux, pip may refuse to install</b></summary>
+<br>
+Most current distributions mark the system Python as *externally managed* (PEP 668), so a
+plain `pip install` stops with `error: externally-managed-environment`. Two ways around it:
+```bash
+# Isolated — recommended, no system packages touched
+pipx install isnady
+# Into your user site — needs the override flag
+pip install isnady --break-system-packages --no-cache-dir -U
+```
+</details>
+### Something not right?
+`iy update` updates every copy of isnady where it is installed. `iy doctor` lists every copy and
+which one each command really starts — an older copy in the user folder can start before a newer
+one elsewhere, so every copy is kept at the same version. The same report is under
+**Help → Check Installation**. If an old copy starts even for `iy update`, run
+`python3 -s -m isnady update` (Windows: `py -s -m isnady update`).
+### Upgrading
+```bash
+iy update
+```
+Your data stays where it is; a newer isnady upgrades the database in place the first time
+it opens it.
+---
+## 🚀 Quick Start
+isnady ships without hadith data: you choose the sources. One command brings in Sahih
+al-Bukhari and Sunan Abi Dawud in Arabic and Turkish from the open
+[fawazahmed0/hadith-api](https://github.com/fawazahmed0/hadith-api) collection (public
+domain):
+```bash
+iy import fawazahmed0 https://cdn.jsdelivr.net/gh/fawazahmed0/hadith-api@1/editions.json \
+   --book bukhari --book abudawud --language ara --language tur --license Unlicense
+```
+Or open the window with `iy` and choose **File → Data Sources**: every built-in collection
+(al-Bukhari, Muslim, Abu Dawud, al-Tirmidhi, al-Nasa'i, Ibn Maja, the Muwatta and three
+forty-hadith books) and the Taqrib import with one click — or **Import all** — in the
+languages you tick. You can add your own files or links there too, and move the data
+folder anywhere you like.
+On the command line:
+```bash
+iy search النيات            # Arabic, with or without diacritics
+iy search "niyetlere göre"   # Turkish, English, any imported language
+iy chain bukhari 1           # one chain, narrator by narrator
+```
+Importing takes a minute or two; the search index and the chains are built as part of it.
+To identify the narrators in those chains, add Ibn Hajar's *Taqrib al-Tahdhib* — 8,824
+narrators with his verdict on each — from the [OpenITI](https://github.com/OpenITI) corpus:
+```bash
+iy import taqrib https://raw.githubusercontent.com/OpenITI/0875AH/master/data/0852IbnHajarCasqalani/0852IbnHajarCasqalani.TaqribTahdhib/0852IbnHajarCasqalani.TaqribTahdhib.JK000121-ara1.completed
+iy narrator الزهري
+```
+---
+## 🔎 Search
+| | |
+|:--|:--|
+| **Arabic without diacritics** | `الاعمال` finds `الأَعْمَالُ`. Alef forms, alef maqsura, hamza seats and ta marbuta are treated alike, so you type the way you normally write |
+| **Attached prefixes** | `النيات` finds `بالنيات`, because Arabic joins bi-, wa-, fa- and al- to the word. *Whole words only* turns this off |
+| **Latin-script text** | Case and accents are ignored: `NIYET`, `niyet` and `nîyet` are one word; `Muʿādh`, `Mu'adh` and `Muadh` too |
+| **Match** | All words, any word, or the exact phrase |
+| **Filters** | Book and language; the language filter also chooses which translations appear |
+| **Grades** | Shown under each hadith with the scholar's name, exactly as given |
+| **Highlighting** | On the original, diacritised text, diacritics included |
+Results appear at once and fill in as you read; the window never waits for them.
+### 👥 Narrators
+The **Narrators** page lists every narrator of the imported rijal work — 8,824 from Ibn
+Hajar's *Taqrib* — searchable in Arabic or in Latin letters (`Abu Hurayra`, `Zuhri`, `Ibn Umar`),
+and filtered by tabaqa, rank and book. For each narrator: Ibn Hajar's verdict and its rank, the
+tabaqa and death year, the books his hadith appear in, **whom he narrates from and who
+narrates from him** in the imported chains, the compilers who narrate from him directly, and
+every hadith whose chain includes him. On the Isnad Chains page a click on a narrator's name
+opens him here.
+Each narrator — and each scholar — is shown by the name he is **known by** (al-A'mash, Ibn 'Umar,
+Abu Hurayra), with his full name and every part of it laid out: name, lineage, kunya, by-name,
+nisbas, client of; the part he is known by is marked ★.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/narrators.png" alt="Narrators — 'Abdullah b. 'Umar: Ibn Hajar's verdict, tabaqa, death year, teachers and students in the chains" width="850">
+</p>
+### 🎓 Hadith Scholars
+The scholars whose work is in the imported data, and what the data measures of it:
+**compilers** (their collection, the teachers their chains begin with, the Companions they end
+with), **graders** (how they grade, and how far they agree with each other on the same hadith —
+agreement, Cohen's kappa, and a strictness index: the classical *mutashaddid* / *mutasahil*,
+measured), and **critics** of narrators (Ibn Hajar's twelve ranks). On Sunan Abi Dawud, for
+example, Zubair 'Ali Za'i grades most strictly (−0.21) and agrees with al-Albani on 70% of the
+hadith; the page also flags a pair of graders whose 98% agreement suggests the source did not keep
+them independent.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/scholars.png" alt="Hadith Scholars — al-Albani: his grades on Sunan Abi Dawud and his agreement with the other graders" width="850">
+</p>
+### 📚 Books
+isnady is not only for searching: the **Books** section opens every imported work and reads it in
+its own order. A hadith collection reads chapter by chapter, each hadith with its card (chain,
+narrators, other narrations, grades) and the languages you choose; Ibn Hajar's *Taqrib* reads
+letter by letter and name by name, each entry with its narrator a click away. Find within a
+chapter, go to the previous or next one, and isnady remembers where you were. From any search
+result, **In its book** opens the hadith where it stands, among the hadith of its chapter.
+Books are not tied to hadith collections: a work is a tree of any depth (volume, book, chapter,
+section) whose leaves are hadith, narrators' entries or paragraphs — so the commentaries, manuals
+of fiqh and other works of the scholars can be read the same way as they are added.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/books.png" alt="Books — reading Sahih al-Bukhari chapter by chapter, Arabic and Turkish, each hadith with its chain" width="850">
+</p>
+```bash
+iy book                      # the books
+iy book bukhari              # its chapters
+iy book bukhari 2 --language Turkish
+iy book taqrib 1
+```
+### 🕌 Shia Rijal
+The Imami tradition's judgments on narrators, on its own terms: al-Najashi's *Rijal* — 1,266
+authors and narrators — read along the two axes of the Imami critics, **reliability** (thiqa;
+praised — *jalil*, *wajh*, *'ayn*; weak) and **creed** (Imami, or Waqifi, Fathi, Zaydi, *'ammi* …),
+which together give the classical four: an Imami *thiqa*, a praised narrator (*mamduh*), a *thiqa*
+of another school (*muwaththaq*), a weak one. The critic's own words are always shown; a creed he
+does not state stays unknown; nothing is mapped onto Ibn Hajar's twelve ranks. Checked on four
+blind samples of entries, each round's misses corrected. The book itself reads in **Books**, and
+the Shia narrators are kept apart from the (Sunni) chains: no chain link is matched to them.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/shia-rijal.png" alt="Shia Rijal — al-Najashi on 'Ali b. al-Husayn b. Babawayh: his words and their reading on the Imami scale" width="850">
+</p>
+Next: al-Tusi's *Rijal* and *Fihrist*, al-'Allama al-Hilli's *Khulasat al-aqwal*, Ibn Dawud's
+*Rijal*, al-Kashshi's reports, and the Four Books with their chains.
+### 📊 Statistics
+Measured in depth, each figure with what it means and how sure it is. Grades are ordered
+categories, so they are never turned into numbers or averaged. The first tab, **Graders**, takes
+the scholars who graded a book (al-Albani, Shu'ayb al-Arna'ut, Zubair 'Ali Za'i, Muhammad Muhyi
+al-Din 'Abd al-Hamid on Sunan Abi Dawud) and shows:
+- agreement of every pair — same grade, Cohen's kappa and the ordinal kappa — with 95% intervals,
+  and Krippendorff's alpha for all of them together;
+- a **Dawid–Skene model** of each hadith's true grade: each grader's confusion matrix (how he grades
+  a hadith of each true grade) and, for every hadith, how sure the model is;
+- **strictness** — the classical *mutashaddid* and *mutasahil*, measured by order only, with intervals;
+- the **disputed hadith**, where the scholars are furthest apart — a double-click opens one in its book.
+Two graders who agree far too often to be independent (98.1%) count as one voice in the model,
+and the page says so. Results are computed once and kept in a file. `iy stats graders`.
+Narrators, books, hadith, chains, correlations and the models follow, tab by tab.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/statistics.png" alt="Statistics — the graders of Sunan Abi Dawud: Krippendorff's alpha, agreement with intervals, the model's certainty" width="850">
+</p>
+### 🎓 Learn
+The terms of hadith and its sciences, written for isnady with their classical sources: 81 terms —
+the grades (sahih, hasan, da'if, mawdu', shadhdh, munkar, mu'allal), the kinds of hadith by their
+chain (mutawatir, mursal, munqati', mu'allaq, mudallas …), chain and text (mutaba'a, shahid,
+takhrij, madar), the ways of receiving (sama', ijaza, haddathana, 'an), judging narrators (the
+twelve ranks of Ibn Hajar, thiqa, saduq, majhul, matruk, mudallis), generations, the parts of an
+Arabic name, Imami rijal, the books, and isnady's own measures. Each with its Arabic, a one-line
+and a longer definition in **English or Turkish**, related terms one click away, and its source.
+The grades on every result explain themselves when you point at them. `iy term mursal --lang tr`.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/learn.png" alt="Learn — the term mursal: Arabic, definition, related terms and source" width="850">
+</p>
+### 🧠 Search by meaning (AI)
+Choose **Match → By meaning (AI)** to find hadith that say the same thing in other words or in
+another language: `komşu hakları` finds the hadith on the neighbour's rights, a Turkish sentence
+finds its Arabic original, and `إنما الأعمال بالنيات` gathers the narrations of the hadith on
+intentions from every imported book. Each result shows how close it is in meaning (0–1), which
+says nothing about authenticity.
+The model is learnt on your computer from the texts you imported — Arabic beside its
+translations is a parallel corpus, and cross-lingual latent semantic analysis learns the
+concepts the languages share. Nothing is downloaded and no outside model is used. Measured on
+al-Bukhari and Abu Dawud: for hadith the model never saw while learning, a Turkish translation
+finds its Arabic original first 68% of the time and among the first ten 93% of the time (chance:
+0.8%). For an exact quotation the ordinary word search stays the better tool.
+The same step finds the **other narrations of each hadith** across the imported books
+(takhrij): every result card says where else it is narrated — *Also narrated in: Sahih
+al-Bukhari 5070 · 6689 · 6953 | Sunan Abi Dawud 2201* — and each number opens that hadith.
+Only the texts are compared, never the chains; upright numbers share the text, italic ones
+probably report the same event from the same Companion. In blind, hand-checked samples 34 of
+35 pairs of the first kind and 18 of 20 of the second were right.
+```bash
+pip install "isnady[ai]"        # numpy and scipy
+iy ai build                     # a few seconds; or Tools → Build AI Indexes
+iy search --mode meaning "komşu hakları"
+iy tahric bukhari 1             # the other narrations of a hadith
+```
+---
+## 🔗 Chains of transmission
+Every Arabic text is read for its chain:
+```
+Sahih al Bukhari 1
+   1. حدثنا (narrated to us)  الْحُمَيْدِيُّ عَبْدُ اللَّهِ بْنُ الزُّبَيْرِ
+   2. حدثنا (narrated to us)  سُفْيَانُ
+   3. حدثنا (narrated to us)  يَحْيَى بْنُ سَعِيدٍ الْأَنْصَارِيُّ
+   4. أخبرني (informed me)    مُحَمَّدُ بْنُ إِبْرَاهِيمَ التَّيْمِيُّ
+   5. سمع (heard)            عَلْقَمَةَ بْنَ وَقَّاصٍ اللَّيْثِيَّ
+   6. سمعت (I heard)          عُمَرَ بْنَ الْخَطَّابِ
+      -> the Prophet
+```
+In the window, each result shows its chain as a row of names ending at the Prophet, and
+**View chain** opens it as a timeline from the book to the Prophet, with the Arabic text
+below: the chain in lighter ink, the text of the hadith in full ink.
+### 👤 Who each narrator is
+With Ibn Hajar's *Taqrib al-Tahdhib* imported, every name in a chain is matched to a
+narrator, and the chain shows what Ibn Hajar says of him: his verdict in his own words, its
+rank on Ibn Hajar's twelve-step scale, the narrator's *tabaqa* (generation) and his death
+year.
+A name is linked only when the evidence leaves one person: the words of the name, the book
+marks (a narrator in al-Bukhari must be one Ibn Hajar marks خ), the order of generations
+along the chain, and the last link before the Prophet being a Companion. When several
+narrators remain — "Sufyan" can be al-Thawri or Ibn 'Uyayna — the chain says so and names
+how many, rather than choosing one. Today about half of all names are identified; in blind,
+hand-checked samples of the identified ones, the last fifty were all correct.
+Names are kept exactly as written, with the clarifications the compilers added
+(*"— yaʿnī Ibn Muḥammad —"*, *"mawlā Ibn ʿAbbās"*), because identifying each narrator is
+a separate step that comes next.
+<details>
+<summary><b>📊 How well it reads today</b></summary>
+<br>
+Measured on Sahih al-Bukhari and Sunan Abi Dawud (12,852 chains):
+| | Bukhari | Abu Dawud | Both |
+|:--|:--:|:--:|:--:|
+| Split into narrators | 85.5% | 71.9% | 79.9% |
+| Of those, reaching the Prophet | | | 78.3% |
+| Narrators per chain | | | 5.0 |
+In a blind, hand-checked sample of 30 chains: **no wrong narrator**, 27 complete.
+The rest are kept whole, each with its reason: *tahwil* (ح, a second chain joining), two
+teachers at one link (*qiran*), a second chain after the first, or wording that could not be
+read with confidence. Abu Dawud uses *qiran* and *tahwil* far more often than Bukhari, which
+is why its share is lower. One known limit: a last narrator introduced only by *qāla*
+("قال قال عبد الله") is not added, because the same words also begin stories.
+</details>
+---
+## 🎓 Educational by Design
+isnady teaches the science it uses. Every transmission term in a chain explains itself:
+| Term | Reads | What the critics took it to mean |
+|:--:|:--|:--|
+| حدثنا | narrated to us | The teacher recited it to a group: heard directly |
+| حدثني | narrated to me | Recited to the narrator alone: heard directly |
+| أخبرنا | informed us | Often a text read back to the teacher (*ʿarḍ*) |
+| أنبأنا | told us | Later often transmission by permission (*ijāza*) |
+| سمعت | I heard | Direct hearing, stated explicitly |
+| قرأت على | I read to | The narrator read the text back to the teacher |
+| عن | from | Does not say how it was received (*ʿanʿana*); connected when the two could have met and the narrator is not known for *tadlīs* |
+| أن | that | Treated by most critics like ʿan (*muʾannan*) |
+The Learn section — hadith terminology, grading, *jarḥ wa taʿdīl* and the classical works,
+each shown on real hadith and real chains — is on the roadmap.
+---
+## 🎨 Appearance
+Seven themes, chosen in **Edit → Preferences → Themes** — each shown as a small live isnady window —
+or in **View → Theme**: *Lapis* (lapis and gold of illuminated manuscripts) and *Lapis Night*, which
+"Follow system" switches between; *Paper* (warm cream and ink, for long reading); *Slate* (quiet and
+modern, with a light sidebar); *Emerald*; *Midnight* (deep dark with teal); and *High Contrast*
+(black, white and yellow, for low vision). `iy config set view.theme paper`.
+Every script has its own reading font, size, colour and line spacing — Arabic, Latin,
+Cyrillic, Bengali and Tamil today, more as sources in other scripts arrive. The light and
+the dark theme each keep their own colours, and the interface font can be changed too.
+**Edit → Preferences** (Ctrl + ,) applies every change at once; each row has its own
+Default button.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/preferences.png" alt="Preferences — font, size, line spacing and colour for each script" width="760">
+</p>
+The same settings from the command line:
+```bash
+iy config list --prefix text.arabic       # what is set, and what is changed
+iy config set text.arabic.size 22
+iy config set text.latin.family "Noto Serif"
+iy config set colors.dark.gilt "#5A4A1E"  # matched words in the dark theme
+iy config reset text.arabic               # back to the defaults
+```
+Settings live in `settings.json` in the isnady data folder, shared by the window and the
+command line.
+---
+## 📚 Data and licences
+isnady reads open formats and keeps the source of everything:
+- **Supported now:** the [fawazahmed0/hadith-api](https://github.com/fawazahmed0/hadith-api)
+  JSON format, from a file or a URL, with or without authentication (username and
+  password, bearer token, or API key; credentials are never stored).
+- **Rijal:** Ibn Hajar's *Taqrib al-Tahdhib* in OpenITI mARkdown — each narrator's name,
+  kunya, verdict, rank, tabaqa, death year and book marks, read by the rules Ibn Hajar sets
+  out in his own introduction. The OpenITI release does not state its licence in the
+  repository, so it is kept as tier C (used on your computer, never redistributed) until
+  it is confirmed.
+- **Coming:** CSV, SQL/SQLite, OpenITI mARkdown, REST APIs and Shamela, so any collection
+  you have can be brought in.
+Every source records a licence **tier**: **A** may be redistributed, **B** may be
+redistributed under its conditions, **C** may not. Sources you add yourself stay on your
+computer. **Help → Licences** lists every source in your database with its licence.
+---
+## ⌨️ CLI
+Everything the window does also works without it — on a server, over SSH, or in a
+script. The command line never loads Qt.
+| Short | Full | What it does |
+|:------|:-----|:-------------|
+| `iy` | `isnady` | Open the window |
+| `iy search WORDS` | `isnady search WORDS` | Search; `--mode all\|any\|phrase`, `--whole-words`, `--book`, `--language`, `--limit` |
+| `iy chain BOOK NUMBER` | `isnady chain bukhari 1` | One chain, narrator by narrator, with who each one is; `--raw` adds the wording |
+| `iy isnads` | `isnady isnads` | Read every chain and report per book; `--rebuild` reads them again |
+| `iy ai build` | `isnady ai build` | Learn the meaning index from the imported texts (`iy ai status` to check) |
+| `iy import najashi FILE` | `isnady catalog import najashi` | al-Najashi's Rijal: Shia narrators read on the Imami scale, and the book |
+| `iy shortcut` | `isnady shortcut --no-desktop` | A desktop and applications-menu shortcut, with isnady's icon |
+| `iy term [NAME]` | `isnady term --search tadlis` | The glossary: a term's meaning, English or Turkish (`--lang tr`) |
+| `iy stats graders` | `isnady stats graders --book abudawud` | The graders of a book in depth: agreement, model, strictness |
+| `iy book [KEY [CHAPTER]]` | `isnady book bukhari 2` | The books; a book's chapters; a chapter read in order |
+| `iy scholar [NAME]` | `isnady scholar albani` | The scholars in the data, or one of them with his measured statistics |
+| `iy tahric BOOK NUMBER` | `isnady tahric bukhari 1` | Other narrations of a hadith in the imported books (takhrij) |
+| `iy search --mode meaning WORDS` | `isnady search --mode meaning "komşu hakları"` | Search by meaning and across languages |
+| `iy narrator NAME` | `isnady narrator "Ibn Umar"` | A narrator: Ibn Hajar's verdict and rank, tabaqa, death year, books, other names; with `--limit 1` also teachers, students and hadith |
+| `iy import FORMAT FILE-OR-URL` | `isnady import …` | Import a source; `--book`, `--language`, `--license`, `--user`, `--token-env`, `--api-key-env` |
+| `iy catalog list` | `isnady catalog list` | Built-in sources and your own, with what is imported — the same as File → Data Sources |
+| `iy catalog import ID` | `isnady catalog import fawaz-muslim --language tur` | Import a listed source; `remove`, `add`, `delete` manage the list |
+| `iy catalog import --all` | `isnady catalog import --all --language ara` | Every built-in source at once |
+| `iy datadir [FOLDER]` | `isnady datadir /data/isnady` | Show or change where the database and settings live; `--as-is`, `--default` |
+| `iy formats` | `isnady formats` | Formats that can be imported |
+| `iy sources` | `isnady sources` | Imported sources, their licence and tier |
+| `iy stats` | `isnady stats` | Hadith, texts, grades and chains per book |
+| `iy remove KEY` | `isnady remove KEY` | Remove a source and everything imported from it |
+| `iy config list\|get\|set\|reset` | `isnady config …` | Appearance and other settings — the same as Edit → Preferences |
+| `iy update` | `isnady update` | Update every copy of isnady where it is installed (system, user, venv, pipx, clone) |
+| `iy doctor` | `isnady doctor` | Every copy of isnady on this computer and which one each command starts |
+| `iy -V` | `isnady -V` | Show the version (also `-v`, `--version`, `version`) |
+| `iy -h` | `isnady -h` | Show help |
+```console
+$ iy search niyet --book abudawud --limit 1
+43 hadith found in 8 ms
+Sunan Abu Dawud #472
+  grades: Al-Albani: Hasan; Muhammad Muhyi Al-Din Abdul Hamid: Hasan; Shuaib Al Arnaut: Daif; Zubair Ali Zai: Daif
+  [Turkish] Ebu Hureyre (r.a.); Resulullah (Sallallahu aleyhi ve Sellem)'in şöyle buyurduğunu rivayet etmiştir: "Bir kimse mescid'e hangi [niyet]le gelirse nasibi ondan ibarettir"
+```
+---
+## 📸 Screenshots
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chain.png" alt="Isnad Chains — the chain of Sahih al-Bukhari 1 as a timeline from the book to the Prophet" width="850">
+</p>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/search-grades.png" alt="Search — Sunan Abi Dawud with each scholar's grade and the chain above the text" width="850">
+</p>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chain-dark.png" alt="Dark theme — a seven-narrator chain from Sunan Abi Dawud" width="850">
+</p>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chains-overview.png" alt="Chains overview — per-book statistics and what was kept whole" width="850">
+</p>
+---
+## 🗺️ Roadmap
+- **Narrators** — the other half of the names identified through teachers and students
+  (al-Mizzi's *Tahdhib al-Kamal*), the verdicts of other critics beside Ibn Hajar's, and
+  whether each link could have met the next.
+- **Hadith scholars** — their lives in full, and more scholars as more collections and grades
+  are imported.
+- **Shia rijal** — narrator verdicts from the Shia rijal works, beside the Sunni view.
+- **Learn** — the sciences of hadith, shown on real hadith and real chains.
+- **More sources and formats** — and adding your own from inside the window.
+- **Glossary** — every Arabic term of hadith and the Islamic sciences explained where it
+  appears: hover or click a term, read its meaning in the interface language.
+- **isnady.net** — the same engine on the web.
+---
+## 🔁 Versions and releases
+One version number on GitHub, PyPI and npm, always. A release builds the Python package and the Windows,
+Linux and macOS applications first; only when every build succeeds is anything published — PyPI, then the
+[GitHub Release](https://github.com/bayramkotan/isnady/releases) with every file and its checksum. What each
+version brought is in the [CHANGELOG](https://github.com/bayramkotan/isnady/blob/main/CHANGELOG.md). The
+README on npm is made from this one.
+## 🏗️ Build from Source
+```bash
+git clone https://github.com/bayramkotan/isnady.git
+cd isnady
+pip install -e .
+iy
+```
+Python 3.10 or newer and PySide6. The command line alone needs no PySide6.
+---
+The desktop application of your own system: `pip install ".[ai]" pyinstaller`, then
+`python packaging/build_app.py linux|windows|macos VERSION`.
+## 📝 License
+MIT for the application code. Hadith data comes from separate sources, each under its own
+licence, recorded with the data and listed under **Help → Licences**.
+The Arabic and reading typeface is [Amiri](https://github.com/aliftype/amiri) by Khaled
+Hosny, bundled under the SIL Open Font License 1.1 (`src/isnady/assets/fonts/OFL.txt`).

package/index.js CHANGED Viewed

@@ -6,7 +6,7 @@
  * database (used by both the Python and JavaScript packages) exists.
  */
-export const version = "0.1.5";
+export const version = "0.1.7";
 export const name = "isnady";
 /** Returns basic package information. */

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "isnady",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Hadith search with full isnad chains, narrator biographies, jarh wa ta'dil verdicts and reliability scores",
   "type": "module",
   "main": "./index.js",