Metadata-Version: 2.4
Name: scriptconv-copyleft
Version: 0.1.1a1
Summary: scriptconv phonemizer backends whose code or dependencies are copyleft (GPL, LGPL, AGPL)
Author-email: TigreGotico <contact@tigregotico.com>
License-Expression: Apache-2.0 AND GPL-3.0-only
Project-URL: Homepage, https://github.com/TigreGotico/scriptconv-copyleft
Project-URL: Repository, https://github.com/TigreGotico/scriptconv-copyleft
Project-URL: Issues, https://github.com/TigreGotico/scriptconv-copyleft/issues
Keywords: g2p,phonemizer,tts,scriptconv,espeak,cotovia,ahotts,kog2p,misaki,transphone
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: scriptconv_copyleft/phonemizers/_vendored/kog2p/LICENSE.md
License-File: scriptconv_copyleft/phonemizers/_vendored/kog2p/COPYING
Requires-Dist: scriptconv[phonemizers]>=0.0.4a88
Provides-Extra: espeak
Requires-Dist: espyak; extra == "espeak"
Provides-Extra: transphone
Requires-Dist: transphone; extra == "transphone"
Requires-Dist: pip; extra == "transphone"
Requires-Dist: jieba; extra == "transphone"
Requires-Dist: pypinyin; extra == "transphone"
Requires-Dist: unidic-lite; extra == "transphone"
Provides-Extra: misaki
Requires-Dist: misaki[en,ko,zh]; python_version < "3.13" and extra == "misaki"
Requires-Dist: python-mecab-ko; python_version < "3.13" and extra == "misaki"
Requires-Dist: fugashi; python_version < "3.13" and extra == "misaki"
Requires-Dist: jaconv; python_version < "3.13" and extra == "misaki"
Requires-Dist: mojimoji; python_version < "3.13" and extra == "misaki"
Requires-Dist: pyopenjtalk; python_version < "3.13" and extra == "misaki"
Requires-Dist: unidic-lite; python_version < "3.13" and extra == "misaki"
Requires-Dist: pip; python_version < "3.13" and extra == "misaki"
Requires-Dist: spacy<4.0,>=3.7; python_version < "3.13" and extra == "misaki"
Provides-Extra: gl
Requires-Dist: pycotovia; extra == "gl"
Provides-Extra: eu
Requires-Dist: ahotts_g2p; extra == "eu"
Provides-Extra: fa
Requires-Dist: persian_phonemizer; extra == "fa"
Requires-Dist: hazm>=0.10; extra == "fa"
Requires-Dist: spacy<4.0,>=3.7; extra == "fa"
Provides-Extra: ja
Requires-Dist: pykakasi<3,>=2.3; extra == "ja"
Provides-Extra: ja-phonemizers
Requires-Dist: pykakasi<3,>=2.3; extra == "ja-phonemizers"
Provides-Extra: ko
Requires-Dist: g2pk; python_version < "3.13" and extra == "ko"
Requires-Dist: regex; extra == "ko"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: espyak; extra == "test"
Requires-Dist: pycotovia; extra == "test"
Requires-Dist: ahotts_g2p; extra == "test"
Requires-Dist: pykakasi<3,>=2.3; extra == "test"
Requires-Dist: epitran>=1.26.1; extra == "test"
Requires-Dist: g2pk; python_version < "3.13" and extra == "test"
Requires-Dist: regex; extra == "test"
Requires-Dist: misaki[en,ko]; python_version < "3.13" and extra == "test"
Requires-Dist: spacy<4.0,>=3.7; python_version < "3.13" and extra == "test"
Requires-Dist: linguatag[langcodes]>=0.2.3a1; extra == "test"
Requires-Dist: packaging; extra == "test"
Dynamic: license-file

# scriptconv-copyleft

The scriptconv phonemizer backends whose own code or whose dependencies are under a copyleft licence (GPL, LGPL or AGPL).

## Where this fits

[scriptconv](https://github.com/TigreGotico/scriptconv) is the text conversion library. Its wheel holds only Apache-2.0 code. Each backend in this package has a copyleft licence somewhere in its chain, so it ships here instead.

scriptconv keeps the registry. A backend keeps its `Phonemizer` value and its routing entry in scriptconv, and scriptconv imports the class from this package only when a caller asks for that backend. The scriptconv extra of each backend installs this package, so the install command does not change:

```bash
pip install scriptconv[espeak]
```

```python
from scriptconv.phonemizers import Phonemizer, get_phonemizer

get_phonemizer(Phonemizer.ESPEAK).phonemize_string("olá", "pt")
```

This package depends on scriptconv. scriptconv never imports this package when it is imported itself.

## Backends

| `Phonemizer` value | Class | Module | Copyleft item in the chain |
| --- | --- | --- | --- |
| `espeak` | `EspeakPhonemizer` | `scriptconv_copyleft.phonemizers.mul` | espyak (GPL-3.0-or-later), the espeak-ng binary (GPL-3.0-or-later) |
| `misaki`, `misaki_en`, `misaki_ja`, `misaki_zh`, `misaki_ko`, `misaki_vi` | `MisakiPhonemizer` and its five subclasses | `scriptconv_copyleft.phonemizers.mul` | phonemizer-fork (GPL-3.0-or-later), espeakng-loader (bundles libespeak-ng) |
| `transphone` | `TransphonePhonemizer` | `scriptconv_copyleft.phonemizers.mul` | cmudict (GPL-3.0-or-later), unidecode (GPL-2.0-or-later), iso-639 (AGPL-3.0) |
| `cotovia` | `CotoviaPhonemizer` | `scriptconv_copyleft.phonemizers.gl` | pycotovia (GPL-3.0-or-later) |
| `ahotts` | `AhoTTSPhonemizer` | `scriptconv_copyleft.phonemizers.eu` | ahotts-g2p (GPL-3.0-or-later) |
| `g2pfa` | `PersianPhonemizer` | `scriptconv_copyleft.phonemizers.fa` | gensim (LGPL-2.1-only), through hazm |
| `g2pk` | `G2PKPhonemizer` | `scriptconv_copyleft.phonemizers.ko` | konlpy (GPL-3.0-or-later) |
| `kog2p` | `KoG2PPhonemizer` | `scriptconv_copyleft.phonemizers.ko` | the vendored KoG2P code (GPL-3.0-only) |
| `pykakasi` | `PyKakasiPhonemizer` | `scriptconv_copyleft.phonemizers.ja` | pykakasi (GPL-3.0-or-later) |

`scriptconv_copyleft.readings` holds the Japanese kanji-to-kana respelling (`tokens`, `to_hiragana`, `to_katakana`), which needs pykakasi.

Each backend's own dependencies install with the extra of the same name, for example `pip install scriptconv-copyleft[espeak]`.

## Licence

The package holds code under two licences. The SPDX expression is `Apache-2.0 AND GPL-3.0-only`.

| Files | Licence | Notice |
| --- | --- | --- |
| `scriptconv_copyleft/phonemizers/_vendored/kog2p/` | GPL-3.0-only | `LICENSE.md` and `COPYING` in that directory. Upstream (scarletcho/KoG2P) ships the GPL version 3 text and states no "or later" grant. |
| every other file | Apache-2.0 | `LICENSE` |

The dependencies of each backend keep their own licences. A program that installs and uses a backend must follow the licence of that backend's dependencies.
