rename from zh-tts to zho-tts

Author: stefantaubert

.gitignore

@@ -109,7 +109,7 @@ venv.bak/
 .vscode
 
 # custom
-# zh_tts/*.tests.py
+# zho_tts/*.tests.py
 output
 scripts
 *_debug/

CITATION.cff

@@ -1,5 +1,5 @@
 cff-version: 1.2.0
-title: zh-tts
+title: zho-tts
 abstract: Command-line interface and Python library for synthesizing Chinese texts into speech.
 message: >-
   If you use this software, please cite it using the

MANIFEST.in

@@ -1,5 +1,5 @@
-graft src/zh_tts_tests/
-graft src/zh_tts_cli_tests/
+graft src/zho_tts_tests/
+graft src/zho_tts_cli_tests/
 
 include \
   pylintrc \

Pipfile

@@ -4,7 +4,7 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-zh-tts = {editable = true, path = "."}
+zho-tts = {editable = true, path = "."}
 autopep8 = "*"
 pylint = "*"
 pycodestyle = "*"

Pipfile.lock

@@ -1,11 +1,11 @@
-# zh-tts
+# zho-tts
 
-[![PyPI](https://img.shields.io/pypi/v/zh-tts.svg)](https://pypi.python.org/pypi/zh-tts)
-![PyPI](https://img.shields.io/pypi/pyversions/zh-tts.svg)
+[![PyPI](https://img.shields.io/pypi/v/zho-tts.svg)](https://pypi.python.org/pypi/zho-tts)
+![PyPI](https://img.shields.io/pypi/pyversions/zho-tts.svg)
 [![pytorch](https://img.shields.io/badge/PyTorch_2.0+-ee4c2c?logo=pytorch&logoColor=white)](https://pytorch.org/get-started/pytorch-2.0/)
 [![MIT](https://img.shields.io/github/license/stefantaubert/zh-tts.svg)](https://github.com/stefantaubert/zh-tts/blob/master/LICENSE)
-[![PyPI](https://img.shields.io/pypi/wheel/zh-tts.svg)](https://pypi.python.org/pypi/zh-tts/#files)
-![PyPI](https://img.shields.io/pypi/implementation/zh-tts.svg)
+[![PyPI](https://img.shields.io/pypi/wheel/zho-tts.svg)](https://pypi.python.org/pypi/zho-tts/#files)
+![PyPI](https://img.shields.io/pypi/implementation/zho-tts.svg)
 [![PyPI](https://img.shields.io/github/commits-since/stefantaubert/zh-tts/latest/master.svg)](https://github.com/stefantaubert/zh-tts/compare/v0.0.1...master)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10512789.svg)](https://doi.org/10.5281/zenodo.10512789)
 
@@ -14,20 +14,20 @@ Command-line interface and Python library for synthesizing Chinese texts into sp
 ## Installation
 
 ```sh
-pip install zh-tts --user
+pip install zho-tts --user
 ```
 
 ## Example synthesis
 
 ```sh
-zh-tts synthesize "长江 航务 管理局 和 长江 轮船 总公司 最近 决定 安排 一百三十三 艘 客轮 迎接 长江 干线 春运。"
+zho-tts synthesize "长江 航务 管理局 和 长江 轮船 总公司 最近 决定 安排 一百三十三 艘 客轮 迎接 长江 干线 春运。"
 ```
 
 The output can be listened [here](https://github.com/stefantaubert/zh-tts/raw/master/examples/synthesize.wav).
 
 ```sh
 # Same example using IPA input
-zh-tts synthesize-ipa "ʈʂː|a˧˩˧˘|ŋ|tɕ˘|j|a˥˘|ŋ˘|SIL0|x|a˧˥˘|ŋ|u˥˩|SIL0|k|w|a˧˩˧|n|l˘|i˧˩˧|tɕː|y˧˥ˑ|SIL0|x|ɤ˧˥|SIL0|ʈʂː|a˧˩˧˘|ŋ|tɕ˘|j|a˥˘|ŋ|SIL0|l|w|ə˧˥|n|ʈʂʰ˘|w|a˧˥|n|SIL0|ts˘|ʊ˧˩˧|ŋ˘|kː|ʊ˥|ŋ|s|ɹ̩˥ˑ|SIL0|ts|w˘|ei̯˥˩|tɕ|i˥˩˘|n|SIL0|tɕ|ɥ|e˧˥|t|i˥˩|ŋ|SIL3|a˥|n|pʰ|ai̯˧˥|SIL0|i˥ˑ|p|ai̯˧˩˧|s|a˥˘|n|ʂ˘|ɻ̩˧˥|s|a˥|n|SIL0|s˘|ou̯˥|SIL0|kʰˑ|ɤ˥˩|lː|wˑ|ə˧˥ˑ|n|SIL0|i˧˥ː|ŋ|tɕ˘|j˘|e˥|SIL0|ʈʂː|a˧˩˧|ŋ|tɕ˘|j|a˥˘|ŋ|SIL0|k˘|a˥˩|n|ɕ|j˘|ɛ˥˩|n˘|SIL0|ʈʂʰˑ|w˘|ə˥˘|nː|y˥˩ˑ|nː|。"
+zho-tts synthesize-ipa "ʈʂː|a˧˩˧˘|ŋ|tɕ˘|j|a˥˘|ŋ˘|SIL0|x|a˧˥˘|ŋ|u˥˩|SIL0|k|w|a˧˩˧|n|l˘|i˧˩˧|tɕː|y˧˥ˑ|SIL0|x|ɤ˧˥|SIL0|ʈʂː|a˧˩˧˘|ŋ|tɕ˘|j|a˥˘|ŋ|SIL0|l|w|ə˧˥|n|ʈʂʰ˘|w|a˧˥|n|SIL0|ts˘|ʊ˧˩˧|ŋ˘|kː|ʊ˥|ŋ|s|ɹ̩˥ˑ|SIL0|ts|w˘|ei̯˥˩|tɕ|i˥˩˘|n|SIL0|tɕ|ɥ|e˧˥|t|i˥˩|ŋ|SIL3|a˥|n|pʰ|ai̯˧˥|SIL0|i˥ˑ|p|ai̯˧˩˧|s|a˥˘|n|ʂ˘|ɻ̩˧˥|s|a˥|n|SIL0|s˘|ou̯˥|SIL0|kʰˑ|ɤ˥˩|lː|wˑ|ə˧˥ˑ|n|SIL0|i˧˥ː|ŋ|tɕ˘|j˘|e˥|SIL0|ʈʂː|a˧˩˧|ŋ|tɕ˘|j|a˥˘|ŋ|SIL0|k˘|a˥˩|n|ɕ|j˘|ɛ˥˩|n˘|SIL0|ʈʂʰˑ|w˘|ə˥˘|nː|y˥˩ˑ|nː|。"
 ```
 
 The output can be listened [here](https://github.com/stefantaubert/zh-tts/raw/master/examples/synthesize-ipa.wav).
@@ -38,7 +38,7 @@ The output can be listened [here](https://github.com/stefantaubert/zh-tts/raw/ma
 from pathlib import Path
 from tempfile import gettempdir
 
-from zh_tts import Synthesizer, Transcriber, normalize_audio, save_audio
+from zho_tts import Synthesizer, Transcriber, normalize_audio, save_audio
 
 text = "长江 航务 管理局 和 长江 轮船 总公司 最近 决定 安排 一百三十三 艘 客轮 迎接 长江 干线 春运。"
 
@@ -99,7 +99,7 @@ Tones and duration markers can be combined, e.g., ə˧˥ː
 If you want to cite this repo, you can use the BibTeX-entry generated by GitHub (see *About => Cite this repository*).
 
 ```txt
-Taubert, S. (2024). zh-tts (Version 0.0.1) [Computer software]. https://doi.org/10.5281/zenodo.10512789
+Taubert, S. (2024). zho-tts (Version 0.0.1) [Computer software]. https://doi.org/10.5281/zenodo.10512789
 ```
 
 ## Acknowledgments

README.md

@@ -1,5 +1,5 @@
 [project]
-name = "zh-tts"
+name = "zho-tts"
 version = "0.0.1"
 description = "Command-line interface and Python library for synthesizing Chinese texts into speech."
 readme = "README.md"
@@ -57,34 +57,34 @@ Homepage = "https://github.com/stefantaubert/zh-tts"
 Issues = "https://github.com/stefantaubert/zh-tts/issues"
 
 [project.scripts]
-zh-tts = "zh_tts_cli.cli:run"
+zho-tts = "zho_tts_cli.cli:run"
 
 [tool.mypy]
 python_version = "3.11"
 warn_return_any = true
 warn_unused_configs = true
 ignore_missing_imports = true
-packages = ["zh_tts", "zh_tts_cli"]
+packages = ["zho_tts", "zho_tts_cli"]
 
 [tool.setuptools.packages.find]
 where = ["src"]
-include = ["zh_tts", "zh_tts.*", "zh_tts_cli", "zh_tts_cli.*"]
+include = ["zho_tts", "zho_tts.*", "zho_tts_cli", "zho_tts_cli.*"]
 exclude = [
-  "zh_tts_tests",
-  "zh_tts_tests.*",
-  "zh_tts_cli_tests",
-  "zh_tts_cli_tests.*",
-  "zh_tts_debug",
-  "zh_tts_debug.*",
-  "zh_tts_cli_debug",
-  "zh_tts_cli_debug.*",
+  "zho_tts_tests",
+  "zho_tts_tests.*",
+  "zho_tts_cli_tests",
+  "zho_tts_cli_tests.*",
+  "zho_tts_debug",
+  "zho_tts_debug.*",
+  "zho_tts_cli_debug",
+  "zho_tts_cli_debug.*",
 ]
 namespaces = true
 
 [tool.pytest.ini_options]
 log_cli = true
 log_level = "DEBUG"
-testpaths = ["src/zh_tts_tests", "src/zh_tts_cli_tests"]
+testpaths = ["src/zho_tts_tests", "src/zho_tts_cli_tests"]
 
 [tool.autopep8]
 indent-size = 2
@@ -94,7 +94,7 @@ max_line_length = 100
 [tool.isort]
 line_length = 100
 indent = 2
-known_first_party = ["zh_tts", "zh_tts_cli"]
+known_first_party = ["zho_tts", "zho_tts_cli"]
 known_third_party = [
   "scipy",
   "numpy",
@@ -117,9 +117,9 @@ deps =
   pytest
 commands = 
   pytest
-  zh-tts
-  zh-tts -v
-  zh-tts -h
+  zho-tts
+  zho-tts -v
+  zho-tts -h
 """
 
 [build-system]

pyproject.toml

@@ -0,0 +1,4 @@
+from zho_tts.helper import get_default_device, normalize_audio
+from zho_tts.io import save_audio
+from zho_tts.synthesizer import AVAILABLE_SPEAKERS, Synthesizer
+from zho_tts.transcriber import Transcriber