readsight 1.0.0__py3-none-any.whl

readsight/__init__.py

@@ -0,0 +1,35 @@
+"""
+ReadSight - Multilingual Readability Library for Python.
+
+86 languages, 17 readability formulas, TeX-based syllable counting
+via the Frank M. Liang hyphenation algorithm.
+"""
+
+from __future__ import annotations
+
+from .config import Config
+from .engine import ReadSight
+from .exceptions import (
+    EmptyTextException,
+    ReadabilityEngineException,
+    UnsupportedFormulaException,
+    UnsupportedLanguageException,
+)
+from .formula.formula_result import FormulaResult
+from .language.language import Language
+from .language.script import Script
+from .text.text_statistics import TextStatistics
+
+__version__ = "1.0.0"
+__all__ = [
+    "Config",
+    "EmptyTextException",
+    "FormulaResult",
+    "Language",
+    "ReadSight",
+    "ReadabilityEngineException",
+    "Script",
+    "TextStatistics",
+    "UnsupportedFormulaException",
+    "UnsupportedLanguageException",
+]

readsight/config.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass(frozen=True, slots=True)
+class Config:
+    patterns_dir: str
+    languages_dir: str
+    cache_dir: str
+
+    @classmethod
+    def default(cls) -> Config:
+        import platformdirs
+
+        pkg_dir = Path(__file__).resolve().parent
+        return cls(
+            patterns_dir=str(pkg_dir / "data" / "patterns"),
+            languages_dir=str(pkg_dir / "data" / "languages"),
+            cache_dir=str(Path(platformdirs.user_cache_dir("readsight", ensure_exists=True))),
+        )

readsight/data/languages/af.json

@@ -0,0 +1,31 @@
+{
+    "code": "af",
+    "name": "Afrikaans",
+    "nativeName": "Afrikaans",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 1,
+        "right": 2
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/ar.json

@@ -0,0 +1,31 @@
+{
+    "code": "ar",
+    "name": "Arabic",
+    "nativeName": "العربية",
+    "script": "Arabic",
+    "hyphenMins": {
+        "left": 0,
+        "right": 0
+    },
+    "letterPattern": "[؀-ۿ]",
+    "wordSplitPattern": "[^\\p{L}]+",
+    "sentenceBoundaryPattern": "[.!?۔]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 5
+        }
+    }
+}

readsight/data/languages/as.json

@@ -0,0 +1,31 @@
+{
+    "code": "as",
+    "name": "Assamese",
+    "nativeName": "অসমীয়া",
+    "script": "Other",
+    "hyphenMins": {
+        "left": 1,
+        "right": 1
+    },
+    "letterPattern": "\\p{L}",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/be.json

@@ -0,0 +1,31 @@
+{
+    "code": "be",
+    "name": "Belarusian",
+    "nativeName": "Беларуская",
+    "script": "Cyrillic",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[А-Яа-яЁёҐ-ӿЀ-ӿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?…]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/bg.json

@@ -0,0 +1,31 @@
+{
+    "code": "bg",
+    "name": "Bulgarian",
+    "nativeName": "Български",
+    "script": "Cyrillic",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[А-Яа-яЁёҐ-ӿЀ-ӿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?…]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/bn.json

@@ -0,0 +1,31 @@
+{
+    "code": "bn",
+    "name": "Bengali",
+    "nativeName": "বাংলা",
+    "script": "Bengali",
+    "hyphenMins": {
+        "left": 1,
+        "right": 1
+    },
+    "letterPattern": "[ঀ-৿]",
+    "wordSplitPattern": "[^\\p{L}]+",
+    "sentenceBoundaryPattern": "[।.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/ca.json

@@ -0,0 +1,31 @@
+{
+    "code": "ca",
+    "name": "Catalan",
+    "nativeName": "Català",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/cop.json

@@ -0,0 +1,31 @@
+{
+    "code": "cop",
+    "name": "Coptic",
+    "nativeName": "ϯⲙⲉⲧⲣⲉⲙⲛⲭⲏⲙⲓ",
+    "script": "Coptic",
+    "hyphenMins": {
+        "left": 1,
+        "right": 1
+    },
+    "letterPattern": "[Ⲁ-⳿]",
+    "wordSplitPattern": "[^\\p{L}]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/cs.json

@@ -0,0 +1,31 @@
+{
+    "code": "cs",
+    "name": "Czech",
+    "nativeName": "Čeština",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 3
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/cu.json

@@ -0,0 +1,31 @@
+{
+    "code": "cu",
+    "name": "Church Slavonic",
+    "nativeName": "ⰔⰎⰑⰂⰡⰐⰠⰔⰍⰟ",
+    "script": "Cyrillic",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[А-Яа-яЁёҐ-ӿЀ-ӿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?…]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/cy.json

@@ -0,0 +1,31 @@
+{
+    "code": "cy",
+    "name": "Welsh",
+    "nativeName": "Cymraeg",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 3
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/da.json

@@ -0,0 +1,31 @@
+{
+    "code": "da",
+    "name": "Danish",
+    "nativeName": "Dansk",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/de-1901.json

@@ -0,0 +1,43 @@
+{
+    "code": "de-1901",
+    "name": "German (traditional)",
+    "nativeName": "Deutsch (traditionell)",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        },
+        "flesch_reading_ease": {
+            "enabled": true,
+            "base": 180,
+            "aslMult": 1,
+            "aswMult": 58.5
+        },
+        "flesch_kincaid_grade_level": {
+            "enabled": true
+        },
+        "wiener_sachtextformel": {
+            "enabled": true
+        }
+    }
+}

readsight/data/languages/de-1996.json

@@ -0,0 +1,43 @@
+{
+    "code": "de-1996",
+    "name": "German (reformed)",
+    "nativeName": "Deutsch (reformiert)",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        },
+        "flesch_reading_ease": {
+            "enabled": true,
+            "base": 180,
+            "aslMult": 1,
+            "aswMult": 58.5
+        },
+        "flesch_kincaid_grade_level": {
+            "enabled": true
+        },
+        "wiener_sachtextformel": {
+            "enabled": true
+        }
+    }
+}

readsight/data/languages/de-ch-1901.json

@@ -0,0 +1,43 @@
+{
+    "code": "de-ch-1901",
+    "name": "German (Swiss traditional)",
+    "nativeName": "Deutsch (Schweiz, traditionell)",
+    "script": "Latin",
+    "hyphenMins": {
+        "left": 2,
+        "right": 2
+    },
+    "letterPattern": "[A-Za-zÀ-ÖØ-öø-ÿĀ-žƀ-ɏḀ-ỿ]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        },
+        "flesch_reading_ease": {
+            "enabled": true,
+            "base": 180,
+            "aslMult": 1,
+            "aswMult": 58.5
+        },
+        "flesch_kincaid_grade_level": {
+            "enabled": true
+        },
+        "wiener_sachtextformel": {
+            "enabled": true
+        }
+    }
+}

readsight/data/languages/el-monoton.json

@@ -0,0 +1,31 @@
+{
+    "code": "el-monoton",
+    "name": "Modern Greek (monotonic)",
+    "nativeName": "Νέα Ελληνικά (μονοτονικό)",
+    "script": "Greek",
+    "hyphenMins": {
+        "left": 1,
+        "right": 1
+    },
+    "letterPattern": "[Α-Ωα-ωἀ-῾]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?;]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}

readsight/data/languages/el-polyton.json

@@ -0,0 +1,31 @@
+{
+    "code": "el-polyton",
+    "name": "Modern Greek (polytonic)",
+    "nativeName": "Νέα Ελληνικά (πολυτονικό)",
+    "script": "Greek",
+    "hyphenMins": {
+        "left": 1,
+        "right": 1
+    },
+    "letterPattern": "[Α-Ωα-ωἀ-῾]",
+    "wordSplitPattern": "[^\\p{L}'’-]+",
+    "sentenceBoundaryPattern": "[.!?;]+",
+    "formulas": {
+        "gunning_fog": {
+            "enabled": true
+        },
+        "smog": {
+            "enabled": true
+        },
+        "coleman_liau": {
+            "enabled": true
+        },
+        "ari": {
+            "enabled": true
+        },
+        "lix": {
+            "enabled": true,
+            "longWordThreshold": 6
+        }
+    }
+}