Merge pull request #151 from gbaian10/ruff_isort

thewh1teagle · web-flow · commit 6489eeae97eb · 2025-04-07T22:56:59.000+03:00
feat: add New Ruff rules
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,9 @@
 {
-    "editor.formatOnSave": true
-}
+  "editor.formatOnSave": true,
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.organizeImports.ruff": "always"
+    }
+  }
+}
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
@@ -19,6 +19,13 @@ uv run ruff format
 uv run ruff check
 ```
 
+If you want to use ruff for quick [safety fixes](https://docs.astral.sh/ruff/linter/#fix-safety),
+you can run the following command:
+
+```console
+uv run ruff check --fix
+```
+
 ## Pull Request Guidelines
 
 Do not create a pull request from your main branch. This ensures we can collaborate and edit the PR if needed.
diff --git a/README.md b/README.md
@@ -1,14 +1,25 @@
 # kokoro-onnx
 
+![Python Version](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
+[![PyPI Release](https://img.shields.io/pypi/v/kokoro-onnx.svg)](https://pypi.org/project/kokoro-onnx/)
+[![Github Model Releases](https://img.shields.io/github/v/release/thewh1teagle/kokoro-onnx)](https://github.com/thewh1teagle/kokoro-onnx/releases)
+[![License](https://img.shields.io/github/license/thewh1teagle/kokoro-onnx)](https://github.com/thewh1teagle/kokoro-onnx/blob/main/LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/thewh1teagle/kokoro-onnx?style=social)](https://github.com/thewh1teagle/kokoro-onnx/stargazers)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/kokoro-onnx?style=plastic)](https://pypi.org/project/kokoro-onnx/)
+
+[![ONNX Runtime](https://img.shields.io/badge/ONNX%20Runtime-%E2%89%A51.20.1-blue)](https://github.com/microsoft/onnxruntime)
+![CPU](https://img.shields.io/badge/CPU-supported-brightgreen)
+![GPU](https://img.shields.io/badge/GPU-supported-brightgreen)
+
 TTS with onnx runtime based on [Kokoro-TTS](https://huggingface.co/spaces/hexgrad/Kokoro-TTS)
 
 🚀 Version 1.0 models are out now! 🎉
 
-https://github.com/user-attachments/assets/00ca06e8-bbbd-4e08-bfb7-23c0acb10ef9
+<https://github.com/user-attachments/assets/00ca06e8-bbbd-4e08-bfb7-23c0acb10ef9>
 
 ## Features
 
-- Supports multiple languages 
+- Supports multiple languages
 - Fast performance near real-time on macOS M1
 - Offer multiple voices
 - Lightweight: ~300MB (quantized: ~80MB)
diff --git a/examples/app.py b/examples/app.py
@@ -16,9 +16,10 @@
 """
 
 import gradio as gr
+import numpy as np
+
 from kokoro_onnx import Kokoro
 from kokoro_onnx.tokenizer import Tokenizer
-import numpy as np
 
 tokenizer = Tokenizer()
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
diff --git a/examples/chinese.py b/examples/chinese.py
@@ -18,9 +18,10 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import zh
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 g2p = zh.ZHG2P(version="1.1")
 
diff --git a/examples/english.py b/examples/english.py
@@ -18,9 +18,10 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import en, espeak
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 fallback = espeak.EspeakFallback(british=False)
 g2p = en.G2P(trf=False, british=False, fallback=fallback)
diff --git a/examples/french.py b/examples/french.py
@@ -18,10 +18,11 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import espeak
 from misaki.espeak import EspeakG2P
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 fallback = espeak.EspeakFallback(british=False)
 g2p = EspeakG2P(language="fr-fr")
diff --git a/examples/hindi.py b/examples/hindi.py
@@ -18,10 +18,11 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import espeak
 from misaki.espeak import EspeakG2P
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 fallback = espeak.EspeakFallback(british=False)
 g2p = EspeakG2P(language="hi")
diff --git a/examples/italian.py b/examples/italian.py
@@ -18,10 +18,11 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import espeak
 from misaki.espeak import EspeakG2P
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 fallback = espeak.EspeakFallback(british=False)
 g2p = EspeakG2P(language="it")
diff --git a/examples/japanse.py b/examples/japanse.py
@@ -18,9 +18,10 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import ja
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 g2p = ja.JAG2P()
 
diff --git a/examples/play.py b/examples/play.py
@@ -9,6 +9,7 @@
 """
 
 import sounddevice as sd
+
 from kokoro_onnx import Kokoro
 
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
diff --git a/examples/podcast.py b/examples/podcast.py
@@ -6,10 +6,12 @@
 python examples/podcast.py
 """
 
+import random
+
+import numpy as np
 import soundfile as sf
+
 from kokoro_onnx import Kokoro
-import numpy as np
-import random
 
 # fmt: off
 sentences = [
diff --git a/examples/portuguese.py b/examples/portuguese.py
@@ -18,10 +18,11 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import espeak
 from misaki.espeak import EspeakG2P
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 fallback = espeak.EspeakFallback(british=False)
 g2p = EspeakG2P(language="pt-br")
diff --git a/examples/save.py b/examples/save.py
@@ -7,6 +7,7 @@
 """
 
 import soundfile as sf
+
 from kokoro_onnx import Kokoro
 
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
diff --git a/examples/spanish.py b/examples/spanish.py
@@ -18,10 +18,11 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from misaki import espeak
 from misaki.espeak import EspeakG2P
 
+from kokoro_onnx import Kokoro
+
 # Misaki G2P with espeak-ng fallback
 fallback = espeak.EspeakFallback(british=False)
 g2p = EspeakG2P(language="es")
diff --git a/examples/with_blending.py b/examples/with_blending.py
@@ -6,9 +6,10 @@
 python examples/with_blending.py
 """
 
+import numpy as np
 import soundfile as sf
+
 from kokoro_onnx import Kokoro
-import numpy as np
 
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
 nicole: np.ndarray = kokoro.get_voice_style("af_nicole")
diff --git a/examples/with_espeak_data.py b/examples/with_espeak_data.py
@@ -7,7 +7,8 @@
 """
 
 import soundfile as sf
-from kokoro_onnx import Kokoro, EspeakConfig
+
+from kokoro_onnx import EspeakConfig, Kokoro
 
 kokoro = Kokoro(
     "kokoro-v1.0.onnx",
diff --git a/examples/with_espeak_lib.py b/examples/with_espeak_lib.py
@@ -10,9 +10,10 @@
 """
 
 import os
+
 import sounddevice as sd
-from kokoro_onnx import Kokoro, EspeakConfig
 
+from kokoro_onnx import EspeakConfig, Kokoro
 
 kokoro = Kokoro(
     "kokoro-v1.0.onnx",
diff --git a/examples/with_gpu.py b/examples/with_gpu.py
@@ -14,6 +14,7 @@
 """
 
 import sounddevice as sd
+
 from kokoro_onnx import Kokoro
 
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
diff --git a/examples/with_log.py b/examples/with_log.py
@@ -9,7 +9,9 @@
 """
 
 import logging
+
 import sounddevice as sd
+
 import kokoro_onnx
 from kokoro_onnx import Kokoro
 
diff --git a/examples/with_phonemes.py b/examples/with_phonemes.py
@@ -7,10 +7,10 @@
 """
 
 import sounddevice as sd
+
 from kokoro_onnx import Kokoro
 from kokoro_onnx.tokenizer import Tokenizer
 
-
 tokenizer = Tokenizer()
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
 
diff --git a/examples/with_provider.py b/examples/with_provider.py
@@ -16,6 +16,7 @@
 """
 
 import soundfile as sf
+
 from kokoro_onnx import Kokoro
 
 kokoro = Kokoro("kokoro-v1.0.onnx", "voices-v1.0.bin")
diff --git a/examples/with_quant.py b/examples/with_quant.py
@@ -17,9 +17,11 @@
    python examples/with_quant.py <chosen_model>
 """
 
+import sys
+
 import sounddevice as sd
+
 from kokoro_onnx import Kokoro
-import sys
 
 kokoro = Kokoro(sys.argv[1], "voices-v1.0.bin")
 samples, sample_rate = kokoro.create(
diff --git a/examples/with_session.py b/examples/with_session.py
@@ -6,11 +6,13 @@
 python examples/with_session.py
 """
 
+import os
+
+import onnxruntime
 import soundfile as sf
-from kokoro_onnx import Kokoro
 from onnxruntime import InferenceSession
-import onnxruntime
-import os
+
+from kokoro_onnx import Kokoro
 
 
 def create_session():
diff --git a/examples/with_stream.py b/examples/with_stream.py
@@ -8,10 +8,11 @@
 python examples/with_stream.py
 """
 
-import sounddevice as sd
-from kokoro_onnx import Kokoro
 import asyncio
 
+import sounddevice as sd
+
+from kokoro_onnx import Kokoro
 
 text = """
 We've just been hearing from Matthew Cappucci, a senior meteorologist at the weather app MyRadar, who says Kansas City is seeing its heaviest snow in 32 years - with more than a foot (30 to 40cm) having come down so far.
diff --git a/examples/with_stream_save.py b/examples/with_stream_save.py
@@ -9,7 +9,8 @@
 import asyncio
 
 import soundfile as sf
-from kokoro_onnx import Kokoro, SAMPLE_RATE
+
+from kokoro_onnx import SAMPLE_RATE, Kokoro
 
 text = """
 We've just been hearing from Matthew Cappucci, a senior meteorologist at the weather app MyRadar, who says Kansas City is seeing its heaviest snow in 32 years - with more than a foot (30 to 40cm) having come down so far.
diff --git a/examples/with_voice.py b/examples/with_voice.py
@@ -8,6 +8,7 @@
 
 import numpy as np
 import soundfile as sf
+
 from kokoro_onnx import Kokoro
 from kokoro_onnx.config import SAMPLE_RATE
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ readme = "README.md"
 authors = [
     { name = "thewh1teagle", email = "61390950+thewh1teagle@users.noreply.github.com" },
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10,<3.14"
 dependencies = [
     "onnxruntime>=1.20.1",
     "colorlog>=6.9.0",
@@ -34,7 +34,19 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [dependency-groups]
-dev = ["ruff>=0.11.0", "sounddevice>=0.5.1", "soundfile>=0.13.0"]
+dev = [
+    "ruff>=0.11.0",
+    "sounddevice>=0.5.1",
+    "soundfile>=0.13.0",
+]
 
 [tool.ruff]
 required-version = ">=0.9.0"
+output-format = "concise"
+show-fixes = true
+
+[tool.ruff.lint]
+extend-select = ["I", "UP"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
diff --git a/scripts/export.py b/scripts/export.py
@@ -21,11 +21,11 @@
 
 import argparse
 import os
-import torch
+
 import onnx
 import onnxruntime as ort
 import sounddevice as sd
-
+import torch
 from kokoro import KModel, KPipeline
 from kokoro.model import KModelForONNX
 
diff --git a/scripts/fetch_voices.py b/scripts/fetch_voices.py
@@ -16,12 +16,13 @@
 """
 
 import io
+import os
+from pathlib import Path
+
 import numpy as np
 import requests
 import torch
-import os
 from tqdm import tqdm
-from pathlib import Path
 
 config = {
     "Kokoro-82M-v1.1-zh": {
diff --git a/src/kokoro_onnx/__init__.py b/src/kokoro_onnx/__init__.py
diff --git a/src/kokoro_onnx/config.py b/src/kokoro_onnx/config.py
diff --git a/src/kokoro_onnx/tokenizer.py b/src/kokoro_onnx/tokenizer.py
diff --git a/src/kokoro_onnx/trim.py b/src/kokoro_onnx/trim.py
diff --git a/uv.lock b/uv.lock
