scriptconv 0.0.1__tar.gz

scriptconv-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

scriptconv-0.0.1/PKG-INFO

@@ -0,0 +1,210 @@
+Metadata-Version: 2.4
+Name: scriptconv
+Version: 0.0.1
+Summary: Shared script-conversion core — ISO-15924 detection, IPA↔ARPA/X-SAMPA/Lexique, Buckwalter, Hangul→jamo
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/scriptconv
+Project-URL: Issues, https://github.com/TigreGotico/scriptconv/issues
+Keywords: ipa,arpabet,x-sampa,lexique,buckwalter,hangul,script,iso15924,tts,g2p,phoneme
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Dynamic: license-file
+
+# scriptconv
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Build Tests](https://github.com/TigreGotico/scriptconv/actions/workflows/build-tests.yml/badge.svg?branch=dev)](https://github.com/TigreGotico/scriptconv/actions/workflows/build-tests.yml)
+[![PyPI version](https://img.shields.io/pypi/v/scriptconv.svg)](https://pypi.org/project/scriptconv/)
+
+**scriptconv** is a zero-dependency Python library for written-script operations:
+ISO-15924 script identification and metadata, character-range detection, language-to-script
+mapping, phoneme-notation transcoding (IPA ↔ ARPABET ↔ X-SAMPA, IPA ↔ Lexique,
+Buckwalter ↔ Arabic script), and orthographic decomposition of Hangul syllable blocks into
+jamo letters. Every conversion is a pure data table or arithmetic operation; no linguistic
+rules, no external files, no runtime dependencies beyond the Python standard library.
+
+Transcoding is reversible where the target inventory permits — see
+[Fidelity guarantees](#fidelity-guarantees) for the exact per-notation guarantees.
+
+## Scope
+
+scriptconv is exclusively about **written scripts**: identification and metadata,
+transliteration between script representations, re-encoding of phoneme symbols
+between notation systems, and orthographic decomposition. It never phonemizes — anything
+that requires knowing how a language *sounds* (grapheme-to-phoneme rules, allophony,
+coarticulation, sandhi) is outside this library's scope.
+
+## Installation
+
+```bash
+pip install scriptconv
+```
+
+### Development
+
+```bash
+uv pip install -e '.[test]'
+pytest tests/
+```
+
+`tests/test_examples.py` runs the scripts under `examples/`, which import the installed
+package — install with `-e` first.
+
+## Quick start
+
+```python
+from scriptconv import (
+    detect_script, char_script, script_distribution, script_runs, base_direction,
+    lang_to_script, script_to_langs, normalize_script_tag, SCRIPT_REGISTRY,
+    arpa_to_ipa, ipa_to_arpa,
+    xsampa_to_ipa, ipa_to_xsampa,
+    buckwalter_to_arabic, arabic_to_buckwalter,
+    lexique_to_ipa, ipa_to_lexique,
+    kirshenbaum_to_ipa, ipa_to_kirshenbaum, looks_like_ipa,
+    decompose_hangul, hira_to_kana, kana_to_hira,
+    convert, can_convert, convert_batch, Notation, NOTATION_INFO,
+)
+
+detect_script("안녕하세요")           # "Hang"
+char_script("ɑ")                    # "Latn" (IPA Extensions)
+script_distribution("Hello مرحبا")   # {'Latn': 5, 'Arab': 5}
+script_runs("привет hello")          # [('Cyrl', 'привет '), ('Latn', 'hello')]
+base_direction("مرحبا بالعالم")      # "rtl"
+SCRIPT_REGISTRY["Arab"].script_type  # "abjad"  (typological class)
+
+lang_to_script("pt-BR")             # "Latn"
+script_to_langs("Cyrl")             # ['av', 'ba', 'be', 'bg', ...]
+normalize_script_tag("syllabics")   # "Cans"
+normalize_script_tag("japanese")    # "Hira"
+
+arpa_to_ipa("HH AH0 L OW1")        # "həloʊ"
+ipa_to_arpa("həloʊ")               # "HH AX L OW"
+
+xsampa_to_ipa("tS")                 # "tʃ"
+ipa_to_xsampa("ɹ")                  # "r\\"
+
+buckwalter_to_arabic("mrHbA")       # "مرحبا"
+arabic_to_buckwalter("مرحبا")      # "mrHbA"
+
+lexique_to_ipa("b§ZuR")            # "bɔ̃ʒuʁ"  (bonjour)
+ipa_to_lexique("vɛ̃")               # "v5"  (vin)
+
+kirshenbaum_to_ipa("S")             # "ʃ"   (espeak-ng ASCII-IPA)
+ipa_to_kirshenbaum("ŋ")             # "N"
+
+looks_like_ipa("pʰɑtʃ")             # True  (heuristic: has IPA-distinctive symbols)
+looks_like_ipa("hello")             # False
+
+decompose_hangul("국민")             # "ㄱㅜㄱㅁㅣㄴ"  (orthographic jamo, no assimilation)
+hira_to_kana("ひらがな")             # "ヒラガナ"
+kana_to_hira("カタカナ")             # "かたかな"
+
+convert("NG", Notation.ARPA, Notation.XSAMPA)  # "N"
+convert("HH AH0 L OW1", "arpa", "kirshenbaum") # "h@loU"
+can_convert("arpa", "x-sampa")                 # True
+can_convert("buckwalter", "ipa")               # False
+list(convert_batch(["HH AH0", "AY1"], "arpa", "ipa"))  # ['hə', 'aɪ']
+
+NOTATION_INFO[Notation.ARPA].lossless_from_ipa  # False (restricted inventory)
+```
+
+### CLI
+
+```bash
+python -m scriptconv convert arpa ipa "HH AH0 L OW1"
+python -m scriptconv detect "안녕하세요"
+python -m scriptconv distribution "Hello مرحبا"
+python -m scriptconv direction "مرحبا بالعالم"
+python -m scriptconv decompose "국민"
+python -m scriptconv lang ko
+```
+
+## Modules
+
+| Module | Contents |
+|--------|----------|
+| `scriptconv.scripts` | `Script` dataclass (with `script_type`), `SCRIPT_REGISTRY` (34 scripts), `detect_script`, `char_script`, `script_distribution`, `script_runs`, `base_direction`, `lang_to_script`, `script_to_langs`, `normalize_script_tag` |
+| `scriptconv.notation` | `Notation` enum, `NotationInfo`/`NOTATION_INFO` fidelity registry, `convert` facade, `can_convert` predicate, `convert_batch` generator, pair-wise converters (ARPABET ↔ IPA, X-SAMPA ↔ IPA, Buckwalter ↔ Arabic, Lexique ↔ IPA, Kirshenbaum ↔ IPA), `looks_like_ipa` detector |
+| `scriptconv.translit` | `decompose_hangul` (Hangul blocks → jamo, compatibility or conjoining), `hira_to_kana`/`kana_to_hira` — all orthographic only |
+
+## Documentation
+
+- [docs/scripts.md](docs/scripts.md) — Script registry, detection, language mapping, label normalisation
+- [docs/notation.md](docs/notation.md) — Notation enum, per-pair converter reference, round-trip guarantees
+- [docs/translit.md](docs/translit.md) — Hangul decomposition arithmetic and scope boundary
+
+## Examples
+
+Runnable scripts in [examples/](examples/):
+
+| File | Demonstrates |
+|------|-------------|
+| `01_detect_script.py` | Mixed-script text triage |
+| `02_lang_to_script.py` | Language tag → ISO-15924 mapping |
+| `03_arpabet_roundtrip.py` | CMUdict-style line → IPA and back |
+| `04_xsampa.py` | X-SAMPA ↔ IPA, multi-char longest-first cases |
+| `05_buckwalter.py` | Arabic ↔ Buckwalter both directions |
+| `06_lexique.py` | French Lexique codes → IPA |
+| `07_hangul_decompose.py` | Hangul syllable blocks → jamo letters |
+| `08_script_distribution.py` | Character counts per script + base direction |
+| `09_script_to_langs.py` | Reverse lookup: script → languages |
+| `10_new_labels.py` | New normalize_script_tag labels (japanese, jamo, cjk…) |
+| `11_cli.py` | CLI interface: detect, distribution, direction, decompose, lang |
+| `12_kirshenbaum.py` | Kirshenbaum (ASCII-IPA) ↔ IPA, and ARPABET → Kirshenbaum routing |
+| `13_script_runs.py` | Per-script segmentation of mixed-script text |
+| `14_kana_transliteration.py` | Hiragana ↔ Katakana |
+
+## Fidelity guarantees
+
+Transcoding faithfulness depends on the target notation's inventory. IPA is the hub;
+notation↔notation goes through IPA. The table below states, for each notation, whether a
+round-trip is exact and what happens to a symbol the table does not know.
+
+| Notation | `to_ipa` → `from_ipa` round-trip | `from_ipa` → `to_ipa` round-trip | Unknown-token behaviour |
+|----------|----------------------------------|----------------------------------|-------------------------|
+| **ARPABET** | Exact for base symbols; **stress digits are dropped** and `AH0`↔`AX` (schwa) is not distinguished | **Lossy** — ARPABET is an English-only inventory, so any IPA symbol outside it becomes the *unknown* placeholder | `arpa_to_ipa`: passed through unchanged. `ipa_to_arpa`: diacritics and suprasegmentals (combining marks, length/stress modifiers) are dropped; other out-of-inventory symbols are replaced with `?` by default (`unknown=` param; `unknown=""` drops) |
+| **X-SAMPA** | Exact for all canonical symbols | Exact except aliases (`f\`→ɸ, `&`→æ) normalise to their canonical spelling | Passed through unchanged |
+| **Buckwalter ↔ Arabic** | Exact (the `^` shadda alias normalises to canonical `~`; precomposed lam-alef ligatures decompose to two chars, visually identical) | Exact | Passed through unchanged |
+| **Lexique ↔ IPA** | Exact except the `°`/`3` schwa pair (both → `ə`; reverse always → `°`) | Exact | Passed through unchanged |
+| **Kirshenbaum ↔ IPA** | Exact | **Lossy** — restricted ASCII inventory; IPA outside it passes through | Passed through unchanged |
+
+This table is also available programmatically via `NOTATION_INFO`
+(`NotationInfo` records with `lossless_to_ipa`, `lossless_from_ipa`,
+`token_separated`, and a `reference` citation per notation).
+
+Notes:
+
+- The voiced velar stop is stored as script `ɡ` (U+0261) across all tables; `ipa_to_arpa`
+  also accepts ASCII `g` (U+0067) on input.
+- Only `ipa_to_arpa` substitutes for unknowns today (because ARPABET is a restricted
+  inventory); every other converter passes unknowns through. See
+  [docs/notation.md](docs/notation.md) for the per-symbol detail.
+
+## License and attribution
+
+scriptconv is released under the **Apache-2.0** license.
+
+Derived tables used internally:
+
+| Table | Source | License |
+|-------|--------|---------|
+| ARPABET ↔ IPA | [chorusai/arpa2ipa](https://github.com/chorusai/arpa2ipa) | Apache-2.0 |
+| Buckwalter ↔ Arabic | Tim Buckwalter's Arabic transliteration scheme | — (factual 1:1 mapping) |
+| Lexique phoneme codes | New, B. & Pallier, C. — *Manuel de Lexique 3* v3.11, Tableau 2; [chrplr/openlexicon](https://github.com/chrplr/openlexicon) | CC BY-SA 4.0 |
+| Kirshenbaum ↔ IPA | Kirshenbaum 1993 ASCII-IPA standard (comp.speech), cross-checked against espeak-ng | — (factual symbol mapping) |
+| Hangul jamo tables | [stannam/hangul_to_ipa](https://github.com/stannam/hangul_to_ipa) | — |

scriptconv-0.0.1/README.md

@@ -0,0 +1,183 @@
+# scriptconv
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Build Tests](https://github.com/TigreGotico/scriptconv/actions/workflows/build-tests.yml/badge.svg?branch=dev)](https://github.com/TigreGotico/scriptconv/actions/workflows/build-tests.yml)
+[![PyPI version](https://img.shields.io/pypi/v/scriptconv.svg)](https://pypi.org/project/scriptconv/)
+
+**scriptconv** is a zero-dependency Python library for written-script operations:
+ISO-15924 script identification and metadata, character-range detection, language-to-script
+mapping, phoneme-notation transcoding (IPA ↔ ARPABET ↔ X-SAMPA, IPA ↔ Lexique,
+Buckwalter ↔ Arabic script), and orthographic decomposition of Hangul syllable blocks into
+jamo letters. Every conversion is a pure data table or arithmetic operation; no linguistic
+rules, no external files, no runtime dependencies beyond the Python standard library.
+
+Transcoding is reversible where the target inventory permits — see
+[Fidelity guarantees](#fidelity-guarantees) for the exact per-notation guarantees.
+
+## Scope
+
+scriptconv is exclusively about **written scripts**: identification and metadata,
+transliteration between script representations, re-encoding of phoneme symbols
+between notation systems, and orthographic decomposition. It never phonemizes — anything
+that requires knowing how a language *sounds* (grapheme-to-phoneme rules, allophony,
+coarticulation, sandhi) is outside this library's scope.
+
+## Installation
+
+```bash
+pip install scriptconv
+```
+
+### Development
+
+```bash
+uv pip install -e '.[test]'
+pytest tests/
+```
+
+`tests/test_examples.py` runs the scripts under `examples/`, which import the installed
+package — install with `-e` first.
+
+## Quick start
+
+```python
+from scriptconv import (
+    detect_script, char_script, script_distribution, script_runs, base_direction,
+    lang_to_script, script_to_langs, normalize_script_tag, SCRIPT_REGISTRY,
+    arpa_to_ipa, ipa_to_arpa,
+    xsampa_to_ipa, ipa_to_xsampa,
+    buckwalter_to_arabic, arabic_to_buckwalter,
+    lexique_to_ipa, ipa_to_lexique,
+    kirshenbaum_to_ipa, ipa_to_kirshenbaum, looks_like_ipa,
+    decompose_hangul, hira_to_kana, kana_to_hira,
+    convert, can_convert, convert_batch, Notation, NOTATION_INFO,
+)
+
+detect_script("안녕하세요")           # "Hang"
+char_script("ɑ")                    # "Latn" (IPA Extensions)
+script_distribution("Hello مرحبا")   # {'Latn': 5, 'Arab': 5}
+script_runs("привет hello")          # [('Cyrl', 'привет '), ('Latn', 'hello')]
+base_direction("مرحبا بالعالم")      # "rtl"
+SCRIPT_REGISTRY["Arab"].script_type  # "abjad"  (typological class)
+
+lang_to_script("pt-BR")             # "Latn"
+script_to_langs("Cyrl")             # ['av', 'ba', 'be', 'bg', ...]
+normalize_script_tag("syllabics")   # "Cans"
+normalize_script_tag("japanese")    # "Hira"
+
+arpa_to_ipa("HH AH0 L OW1")        # "həloʊ"
+ipa_to_arpa("həloʊ")               # "HH AX L OW"
+
+xsampa_to_ipa("tS")                 # "tʃ"
+ipa_to_xsampa("ɹ")                  # "r\\"
+
+buckwalter_to_arabic("mrHbA")       # "مرحبا"
+arabic_to_buckwalter("مرحبا")      # "mrHbA"
+
+lexique_to_ipa("b§ZuR")            # "bɔ̃ʒuʁ"  (bonjour)
+ipa_to_lexique("vɛ̃")               # "v5"  (vin)
+
+kirshenbaum_to_ipa("S")             # "ʃ"   (espeak-ng ASCII-IPA)
+ipa_to_kirshenbaum("ŋ")             # "N"
+
+looks_like_ipa("pʰɑtʃ")             # True  (heuristic: has IPA-distinctive symbols)
+looks_like_ipa("hello")             # False
+
+decompose_hangul("국민")             # "ㄱㅜㄱㅁㅣㄴ"  (orthographic jamo, no assimilation)
+hira_to_kana("ひらがな")             # "ヒラガナ"
+kana_to_hira("カタカナ")             # "かたかな"
+
+convert("NG", Notation.ARPA, Notation.XSAMPA)  # "N"
+convert("HH AH0 L OW1", "arpa", "kirshenbaum") # "h@loU"
+can_convert("arpa", "x-sampa")                 # True
+can_convert("buckwalter", "ipa")               # False
+list(convert_batch(["HH AH0", "AY1"], "arpa", "ipa"))  # ['hə', 'aɪ']
+
+NOTATION_INFO[Notation.ARPA].lossless_from_ipa  # False (restricted inventory)
+```
+
+### CLI
+
+```bash
+python -m scriptconv convert arpa ipa "HH AH0 L OW1"
+python -m scriptconv detect "안녕하세요"
+python -m scriptconv distribution "Hello مرحبا"
+python -m scriptconv direction "مرحبا بالعالم"
+python -m scriptconv decompose "국민"
+python -m scriptconv lang ko
+```
+
+## Modules
+
+| Module | Contents |
+|--------|----------|
+| `scriptconv.scripts` | `Script` dataclass (with `script_type`), `SCRIPT_REGISTRY` (34 scripts), `detect_script`, `char_script`, `script_distribution`, `script_runs`, `base_direction`, `lang_to_script`, `script_to_langs`, `normalize_script_tag` |
+| `scriptconv.notation` | `Notation` enum, `NotationInfo`/`NOTATION_INFO` fidelity registry, `convert` facade, `can_convert` predicate, `convert_batch` generator, pair-wise converters (ARPABET ↔ IPA, X-SAMPA ↔ IPA, Buckwalter ↔ Arabic, Lexique ↔ IPA, Kirshenbaum ↔ IPA), `looks_like_ipa` detector |
+| `scriptconv.translit` | `decompose_hangul` (Hangul blocks → jamo, compatibility or conjoining), `hira_to_kana`/`kana_to_hira` — all orthographic only |
+
+## Documentation
+
+- [docs/scripts.md](docs/scripts.md) — Script registry, detection, language mapping, label normalisation
+- [docs/notation.md](docs/notation.md) — Notation enum, per-pair converter reference, round-trip guarantees
+- [docs/translit.md](docs/translit.md) — Hangul decomposition arithmetic and scope boundary
+
+## Examples
+
+Runnable scripts in [examples/](examples/):
+
+| File | Demonstrates |
+|------|-------------|
+| `01_detect_script.py` | Mixed-script text triage |
+| `02_lang_to_script.py` | Language tag → ISO-15924 mapping |
+| `03_arpabet_roundtrip.py` | CMUdict-style line → IPA and back |
+| `04_xsampa.py` | X-SAMPA ↔ IPA, multi-char longest-first cases |
+| `05_buckwalter.py` | Arabic ↔ Buckwalter both directions |
+| `06_lexique.py` | French Lexique codes → IPA |
+| `07_hangul_decompose.py` | Hangul syllable blocks → jamo letters |
+| `08_script_distribution.py` | Character counts per script + base direction |
+| `09_script_to_langs.py` | Reverse lookup: script → languages |
+| `10_new_labels.py` | New normalize_script_tag labels (japanese, jamo, cjk…) |
+| `11_cli.py` | CLI interface: detect, distribution, direction, decompose, lang |
+| `12_kirshenbaum.py` | Kirshenbaum (ASCII-IPA) ↔ IPA, and ARPABET → Kirshenbaum routing |
+| `13_script_runs.py` | Per-script segmentation of mixed-script text |
+| `14_kana_transliteration.py` | Hiragana ↔ Katakana |
+
+## Fidelity guarantees
+
+Transcoding faithfulness depends on the target notation's inventory. IPA is the hub;
+notation↔notation goes through IPA. The table below states, for each notation, whether a
+round-trip is exact and what happens to a symbol the table does not know.
+
+| Notation | `to_ipa` → `from_ipa` round-trip | `from_ipa` → `to_ipa` round-trip | Unknown-token behaviour |
+|----------|----------------------------------|----------------------------------|-------------------------|
+| **ARPABET** | Exact for base symbols; **stress digits are dropped** and `AH0`↔`AX` (schwa) is not distinguished | **Lossy** — ARPABET is an English-only inventory, so any IPA symbol outside it becomes the *unknown* placeholder | `arpa_to_ipa`: passed through unchanged. `ipa_to_arpa`: diacritics and suprasegmentals (combining marks, length/stress modifiers) are dropped; other out-of-inventory symbols are replaced with `?` by default (`unknown=` param; `unknown=""` drops) |
+| **X-SAMPA** | Exact for all canonical symbols | Exact except aliases (`f\`→ɸ, `&`→æ) normalise to their canonical spelling | Passed through unchanged |
+| **Buckwalter ↔ Arabic** | Exact (the `^` shadda alias normalises to canonical `~`; precomposed lam-alef ligatures decompose to two chars, visually identical) | Exact | Passed through unchanged |
+| **Lexique ↔ IPA** | Exact except the `°`/`3` schwa pair (both → `ə`; reverse always → `°`) | Exact | Passed through unchanged |
+| **Kirshenbaum ↔ IPA** | Exact | **Lossy** — restricted ASCII inventory; IPA outside it passes through | Passed through unchanged |
+
+This table is also available programmatically via `NOTATION_INFO`
+(`NotationInfo` records with `lossless_to_ipa`, `lossless_from_ipa`,
+`token_separated`, and a `reference` citation per notation).
+
+Notes:
+
+- The voiced velar stop is stored as script `ɡ` (U+0261) across all tables; `ipa_to_arpa`
+  also accepts ASCII `g` (U+0067) on input.
+- Only `ipa_to_arpa` substitutes for unknowns today (because ARPABET is a restricted
+  inventory); every other converter passes unknowns through. See
+  [docs/notation.md](docs/notation.md) for the per-symbol detail.
+
+## License and attribution
+
+scriptconv is released under the **Apache-2.0** license.
+
+Derived tables used internally:
+
+| Table | Source | License |
+|-------|--------|---------|
+| ARPABET ↔ IPA | [chorusai/arpa2ipa](https://github.com/chorusai/arpa2ipa) | Apache-2.0 |
+| Buckwalter ↔ Arabic | Tim Buckwalter's Arabic transliteration scheme | — (factual 1:1 mapping) |
+| Lexique phoneme codes | New, B. & Pallier, C. — *Manuel de Lexique 3* v3.11, Tableau 2; [chrplr/openlexicon](https://github.com/chrplr/openlexicon) | CC BY-SA 4.0 |
+| Kirshenbaum ↔ IPA | Kirshenbaum 1993 ASCII-IPA standard (comp.speech), cross-checked against espeak-ng | — (factual symbol mapping) |
+| Hangul jamo tables | [stannam/hangul_to_ipa](https://github.com/stannam/hangul_to_ipa) | — |

scriptconv-0.0.1/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scriptconv"
+dynamic = ["version", "dependencies"]
+description = "Shared script-conversion core — ISO-15924 detection, IPA↔ARPA/X-SAMPA/Lexique, Buckwalter, Hangul→jamo"
+readme = "README.md"
+license = {text = "Apache-2.0"}
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Topic :: Text Processing :: Linguistic",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+keywords = ["ipa", "arpabet", "x-sampa", "lexique", "buckwalter", "hangul", "script", "iso15924", "tts", "g2p", "phoneme"]
+
+[tool.setuptools.dynamic]
+version = {attr = "scriptconv.version.VERSION_STR"}
+dependencies = {file = ["requirements.txt"]}
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-timeout"]
+
+[project.urls]
+Homepage = "https://github.com/TigreGotico/scriptconv"
+Issues = "https://github.com/TigreGotico/scriptconv/issues"
+
+[tool.setuptools.packages.find]
+include = ["scriptconv*"]
+
+[tool.setuptools.package-data]
+scriptconv = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]