cmd-kural 0.1.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cmd_kural-0.1.2.dist-info/METADATA +510 -0
- cmd_kural-0.1.2.dist-info/RECORD +72 -0
- cmd_kural-0.1.2.dist-info/WHEEL +4 -0
- cmd_kural-0.1.2.dist-info/entry_points.txt +2 -0
- cmd_kural-0.1.2.dist-info/licenses/LICENSE +34 -0
- kural/__init__.py +3 -0
- kural/__main__.py +345 -0
- kural/config/__init__.py +8 -0
- kural/config/app_rules.defaults.yaml +68 -0
- kural/config/commands.defaults.yaml +65 -0
- kural/config/config.defaults.yaml +212 -0
- kural/config/config_manager.py +568 -0
- kural/config/configcheck.py +218 -0
- kural/config/defaults_merge.py +269 -0
- kural/control/__init__.py +79 -0
- kural/control/app_index.py +270 -0
- kural/control/app_rules.py +149 -0
- kural/control/autostart.py +112 -0
- kural/control/chords.py +90 -0
- kural/control/executor.py +365 -0
- kural/control/guardrails.py +154 -0
- kural/control/llm_fallback.py +137 -0
- kural/control/media.py +247 -0
- kural/control/mouse.py +185 -0
- kural/control/parser.py +448 -0
- kural/control/planner.py +250 -0
- kural/control/windows.py +672 -0
- kural/doctor.py +344 -0
- kural/engine/__init__.py +6 -0
- kural/engine/adaptive.py +231 -0
- kural/engine/audio_ducking.py +104 -0
- kural/engine/audio_feedback.py +130 -0
- kural/engine/audio_gain.py +40 -0
- kural/engine/audio_recorder.py +547 -0
- kural/engine/bundle_logs.py +175 -0
- kural/engine/cues.py +80 -0
- kural/engine/dictation_cleanup.py +358 -0
- kural/engine/dictation_languages.py +96 -0
- kural/engine/dictionary.py +104 -0
- kural/engine/file_transcriber.py +293 -0
- kural/engine/flow_formatting.py +118 -0
- kural/engine/hardware_detection.py +237 -0
- kural/engine/history.py +188 -0
- kural/engine/instance_manager.py +154 -0
- kural/engine/log_setup.py +83 -0
- kural/engine/model_registry.py +184 -0
- kural/engine/model_transfer.py +233 -0
- kural/engine/noise_suppression.py +51 -0
- kural/engine/notes.py +80 -0
- kural/engine/recovery.py +196 -0
- kural/engine/server.py +322 -0
- kural/engine/snippets.py +96 -0
- kural/engine/stop_phrase.py +74 -0
- kural/engine/streaming.py +106 -0
- kural/engine/streaming_delivery.py +127 -0
- kural/engine/streaming_manager.py +127 -0
- kural/engine/streaming_recognizer.py +163 -0
- kural/engine/transforms.py +288 -0
- kural/engine/utils.py +296 -0
- kural/engine/voice_activity_detection.py +336 -0
- kural/engine/wake_word.py +83 -0
- kural/engine/whisper_engine.py +412 -0
- kural/runtime.py +814 -0
- kural/selftest.py +198 -0
- kural/ui/__init__.py +9 -0
- kural/ui/cheat_sheet.py +245 -0
- kural/ui/fallback_window.py +240 -0
- kural/ui/history_window.py +277 -0
- kural/ui/overlay.py +315 -0
- kural/ui/settings_window.py +500 -0
- kural/ui/terminal_title.py +152 -0
- kural/ui/tray.py +161 -0
|
@@ -0,0 +1,510 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: cmd-kural
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: Local-first voice typing and voice control for Windows. English and Tamil. GPU-accelerated Whisper, no cloud.
|
|
5
|
+
License: MIT License
|
|
6
|
+
|
|
7
|
+
Copyright (c) 2024 Mohamed Aashir S
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
+
in the Software without restriction, including without limitation the rights
|
|
12
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
+
furnished to do so, subject to the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be included in all
|
|
17
|
+
copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
25
|
+
SOFTWARE.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
This project incorporates code from the following MIT-licensed sources:
|
|
30
|
+
|
|
31
|
+
drajb/whisper-local (fork of Pin Wang's whisper-key-local)
|
|
32
|
+
Copyright (c) Pin Wang
|
|
33
|
+
Copyright (c) drajb contributors
|
|
34
|
+
MIT License — see THIRD_PARTY_NOTICES.md
|
|
35
|
+
|
|
36
|
+
ROHITCRAFTSYT/WhispLocal
|
|
37
|
+
Copyright (c) Rohit Burani / ROHITCRAFTSYT
|
|
38
|
+
MIT License — see THIRD_PARTY_NOTICES.md
|
|
39
|
+
License-File: LICENSE
|
|
40
|
+
Requires-Python: >=3.12
|
|
41
|
+
Requires-Dist: numpy>=1.26.0
|
|
42
|
+
Requires-Dist: ruamel-yaml>=0.18.0
|
|
43
|
+
Provides-Extra: dev
|
|
44
|
+
Requires-Dist: pyinstaller>=6.0; extra == 'dev'
|
|
45
|
+
Requires-Dist: pytest-mock>=3.14; extra == 'dev'
|
|
46
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
47
|
+
Requires-Dist: ruff>=0.4; extra == 'dev'
|
|
48
|
+
Provides-Extra: runtime
|
|
49
|
+
Requires-Dist: faster-whisper>=1.0.0; extra == 'runtime'
|
|
50
|
+
Requires-Dist: global-hotkeys>=0.1.0; extra == 'runtime'
|
|
51
|
+
Requires-Dist: pyperclip>=1.8.2; extra == 'runtime'
|
|
52
|
+
Requires-Dist: sounddevice>=0.4.6; extra == 'runtime'
|
|
53
|
+
Requires-Dist: soxr>=0.3.7; extra == 'runtime'
|
|
54
|
+
Provides-Extra: tray
|
|
55
|
+
Requires-Dist: pillow>=10.0.0; extra == 'tray'
|
|
56
|
+
Requires-Dist: pystray>=0.19.5; extra == 'tray'
|
|
57
|
+
Provides-Extra: vad
|
|
58
|
+
Requires-Dist: ten-vad>=0.0.4; extra == 'vad'
|
|
59
|
+
Description-Content-Type: text/markdown
|
|
60
|
+
|
|
61
|
+
<meta name="description" content="Kural is a local-first Windows speech-to-text and voice typing app with GPU-accelerated Whisper, voice commands, and support for English, Tamil, and Tanglish. No cloud transcription.">
|
|
62
|
+
<meta name="keywords" content="offline speech to text, Windows voice typing, local Whisper, Tamil speech recognition, Tanglish voice commands, GPU transcription, privacy-first dictation">
|
|
63
|
+
|
|
64
|
+
# Kural (குரல்)
|
|
65
|
+
|
|
66
|
+
> Offline speech-to-text, voice typing, and voice commands for Windows. Powered by local GPU-accelerated Whisper; supports English, Tamil, and Tanglish without cloud transcription.
|
|
67
|
+
|
|
68
|
+
**Latest release: [Kural v0.1.0](https://github.com/mdaashir/kural/releases/tag/v0.1.0)** — download the [Windows installer](https://github.com/mdaashir/kural/releases/download/v0.1.0/kural-windows-x64-setup.exe), [portable Windows bundle](https://github.com/mdaashir/kural/releases/download/v0.1.0/kural-windows-x64.zip), or [Python wheel](https://github.com/mdaashir/kural/releases/download/v0.1.0/kural-0.1.0-py3-none-any.whl). Verify downloads with the release [SHA256SUMS](https://github.com/mdaashir/kural/releases/download/v0.1.0/SHA256SUMS).
|
|
69
|
+
|
|
70
|
+
[](https://www.python.org/)
|
|
71
|
+
[](https://www.microsoft.com/windows)
|
|
72
|
+
[](https://developer.nvidia.com/cuda-zone)
|
|
73
|
+
[](LICENSE)
|
|
74
|
+
[](https://github.com/mdaashir/kural/actions/workflows/ci.yml)
|
|
75
|
+
[](tests/)
|
|
76
|
+
|
|
77
|
+
Kural merges two MIT-licensed upstream projects into one cohesive desktop voice assistant:
|
|
78
|
+
the **GPU speech engine** from `drajb/whisper-local` with the **deep voice-control engine**
|
|
79
|
+
from `ROHITCRAFTSYT/WhispLocal` — extended with Tamil/Tanglish support, Wispr Flow-style UX,
|
|
80
|
+
and Windows-native privacy features.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Key Highlights
|
|
85
|
+
|
|
86
|
+
- **Bilingual Voice Typing & Control:** Native script Tamil (*தமிழ்*), English, and code-switched Tanglish (*"chrome open பண்ணு"*, *"notepad திற"*).
|
|
87
|
+
- **GPU Accelerated:** `large-v3-turbo` on CUDA `float16` targeting the NVIDIA RTX 3050 (6 GB). CPU `int8` fallback with a visible warning.
|
|
88
|
+
- **Idle VRAM Unload:** Automatically releases GPU memory after configurable inactivity (default: 5 min), transparently reloading on next dictation — freeing ~1.5 GB on the RTX 3050 for other apps.
|
|
89
|
+
- **Deep Windows Voice Control:**
|
|
90
|
+
- Launch & switch apps indexed from the Windows Start Menu and Microsoft Store.
|
|
91
|
+
- Multi-tier fuzzy matching and second-pass misheard-verb recovery (*"oben chrome"* → *"open chrome"*).
|
|
92
|
+
- Graceful window closing (`WM_CLOSE`), window snapping, minimizing, and maximizing.
|
|
93
|
+
- System volume & media transport controls via Windows Core Audio.
|
|
94
|
+
- **Strict Guardrails:** Blocks file deletion, partition formatting, and autonomous payments. Delayed 60 s cancellable window for shutdown/restart.
|
|
95
|
+
- **Elevated Window Detection:** Detects UIPI-blocked Administrator windows and notifies the user instead of silently dropping synthetic input.
|
|
96
|
+
- **Wispr Flow-style UX:**
|
|
97
|
+
- Animated 7-bar soundwave equalizer pill with live mic level during recording.
|
|
98
|
+
- Live partial speech streaming preview in the pill while Whisper processes.
|
|
99
|
+
- Soft synthesized bell-chime audio cues (no audio files on disk).
|
|
100
|
+
- Push-to-talk via keyboard hotkey, multi-key chord (`ctrl+windows`, `ctrl+alt`), or mouse thumb button (Mouse Flow).
|
|
101
|
+
- **Privacy-First:**
|
|
102
|
+
- Zero runtime telemetry or cloud calls.
|
|
103
|
+
- **Incognito Mode:** disables transcript history, adaptive learning, audio retention, and in-memory Paste Last retention while active. Entering Incognito clears any prior retained take and ledger text.
|
|
104
|
+
- DPAPI-encrypted audio retention for one-click retry and paste-last recovery when Incognito is off.
|
|
105
|
+
- Transcript text is never logged at INFO level.
|
|
106
|
+
- **Never-Lose-A-Dictation:** Paste last dictation and retry last recording directly from the system tray.
|
|
107
|
+
- **Text Delivery Choice:** Clipboard paste (`paste` / Ctrl+V), direct SendInput Unicode keystrokes (`type`) for paste-blocked apps, or Copy Only (`copy`) to clipboard without disturbing foreground focus (Hex-inspired).
|
|
108
|
+
- **100% Local:** Air-gapped text pipeline. The only network call is the one-time model download.
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Architecture Overview
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
kural/
|
|
116
|
+
├── engine/ # Audio capture, faster-whisper inference, VRAM lifecycle
|
|
117
|
+
│ ├── whisper_engine.py faster-whisper CUDA float16 + idle VRAM unload timer
|
|
118
|
+
│ ├── file_transcriber.py Offline audio file transcription CLI (Hex-inspired)
|
|
119
|
+
│ ├── audio_recorder.py Ring-buffer continuous WASAPI capture with resampling
|
|
120
|
+
│ ├── audio_ducking.py Automatic playback volume ducking while dictating (Hex-inspired)
|
|
121
|
+
│ ├── stop_phrase.py Hands-free voice stop phrase detection & stripping (Hex-inspired)
|
|
122
|
+
│ ├── audio_feedback.py Soft synthesized bell-chime audio cues (no WAV files)
|
|
123
|
+
│ ├── audio_gain.py Whisper Mode adaptive booster for quiet/whispered speech
|
|
124
|
+
│ ├── cues.py Pure-Python sine harmonic WAV synthesis (stdlib only)
|
|
125
|
+
│ ├── streaming.py Real-time partial speech preview in the overlay pill
|
|
126
|
+
│ ├── hardware_detection.py GPU & CUDA DLL diagnostics (cuBLAS, cuDNN)
|
|
127
|
+
│ ├── voice_activity_detection.py TEN VAD silence detector
|
|
128
|
+
│ ├── wake_word.py Optional offline keyword listener (behind config flag)
|
|
129
|
+
│ ├── model_registry.py Local & HuggingFace cache management
|
|
130
|
+
│ ├── flow_formatting.py Disfluency stripper & spoken punctuation engine
|
|
131
|
+
│ ├── dictation_cleanup.py Text normalization pipeline
|
|
132
|
+
│ ├── dictation_languages.py EN/TA language and prompt configuration
|
|
133
|
+
│ ├── snippets.py Inline text snippet expansion (${date}, ${clipboard})
|
|
134
|
+
│ ├── dictionary.py Custom hotword dictionary (--dict-add/list/remove)
|
|
135
|
+
│ ├── adaptive.py On-disk adaptive vocabulary learning (adaptive.json)
|
|
136
|
+
│ ├── history.py JSONL history logger with BM25 full-text search
|
|
137
|
+
│ ├── recovery.py DPAPI-encrypted LastTake audio retention & Ledger
|
|
138
|
+
│ ├── notes.py Voice-capture to Obsidian/Markdown daily journal
|
|
139
|
+
│ ├── server.py Local OpenAI-compatible speech API (127.0.0.1)
|
|
140
|
+
│ └── utils.py %APPDATA% path helpers & version reader
|
|
141
|
+
│
|
|
142
|
+
├── control/ # Voice-control brain, automation, and OS integration
|
|
143
|
+
│ ├── executor.py 5-tier command resolution: exact → built-in → fuzzy → LLM → error
|
|
144
|
+
│ ├── parser.py Pure intent parser (SVO/SOV, English, Tamil, Tanglish)
|
|
145
|
+
│ ├── tamil_parser.py Native Tamil & Tanglish alias matching
|
|
146
|
+
│ ├── app_index.py Start Menu & Store app indexer with fuzzy matching
|
|
147
|
+
│ ├── app_rules.py Per-app contextual delivery (verbatim, formal, casual…)
|
|
148
|
+
│ ├── planner.py Caret-aware continuation layout planner
|
|
149
|
+
│ ├── windows.py Window info, snap, focus; Unicode SendInput injection
|
|
150
|
+
│ ├── chords.py Multi-key push-to-talk chord tracker (ChordMatcher)
|
|
151
|
+
│ ├── mouse.py Win32 WH_MOUSE_LL mouse-button push-to-talk (Mouse Flow)
|
|
152
|
+
│ ├── media.py Windows Core Audio volume & media transport
|
|
153
|
+
│ ├── guardrails.py Safety allowlist & destructive action blocker
|
|
154
|
+
│ ├── llm_fallback.py Air-gapped local-LLM intent fallback (GGUF/ONNX)
|
|
155
|
+
│ ├── autostart.py Windows Run registry startup integration
|
|
156
|
+
│ └── elevation.py UIPI elevated-window detection
|
|
157
|
+
│
|
|
158
|
+
├── config/ # Layered configuration & defaults
|
|
159
|
+
│ ├── config_manager.py %APPDATA%\kural overlay + schema validation + auto-heal
|
|
160
|
+
│ ├── configcheck.py Key-by-key schema validator with typed bounds
|
|
161
|
+
│ ├── config.defaults.yaml Engine & control defaults (all sections)
|
|
162
|
+
│ └── commands.defaults.yaml Bilingual voice command triggers
|
|
163
|
+
│
|
|
164
|
+
├── ui/ # Desktop visual surface
|
|
165
|
+
│ ├── overlay.py Animated 7-bar soundwave equalizer pill (Tkinter)
|
|
166
|
+
│ ├── tray.py Windows notification area icon with recovery actions
|
|
167
|
+
│ ├── settings_window.py Graphical settings dialog (tabbed, Tkinter)
|
|
168
|
+
│ ├── history_window.py Dark-theme history browser with live BM25 search
|
|
169
|
+
│ └── cheat_sheet.py Shortcuts & commands quick-reference dialog
|
|
170
|
+
│
|
|
171
|
+
├── doctor.py # `kural --doctor` diagnostic health check
|
|
172
|
+
├── runtime.py # Main daemon: state machine, hotkeys, audio loop
|
|
173
|
+
├── benchmarks/ # ASR harness: WER, Tamil CER, RTF on GPU
|
|
174
|
+
└── packaging/ # Standalone PyInstaller build (kural.exe)
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## Getting Started
|
|
180
|
+
|
|
181
|
+
### Prerequisites
|
|
182
|
+
|
|
183
|
+
- **OS:** Windows 11 (AMD64)
|
|
184
|
+
- **Python:** 3.12+ (managed with `uv` or system Python)
|
|
185
|
+
- **GPU (Recommended):** NVIDIA RTX 3050 or any CUDA 12-compatible GPU with latest drivers
|
|
186
|
+
|
|
187
|
+
### Installation
|
|
188
|
+
|
|
189
|
+
```powershell
|
|
190
|
+
# Clone the repository
|
|
191
|
+
git clone https://github.com/mdaashir/kural.git
|
|
192
|
+
cd kural
|
|
193
|
+
|
|
194
|
+
# Create environment and install dependencies
|
|
195
|
+
uv venv
|
|
196
|
+
.\.venv\Scripts\activate
|
|
197
|
+
|
|
198
|
+
# Core package (library + diagnostics)
|
|
199
|
+
uv pip install -e .
|
|
200
|
+
|
|
201
|
+
# Full desktop runtime (dictation engine, audio, hotkeys, UI)
|
|
202
|
+
uv pip install -e ".[runtime]"
|
|
203
|
+
|
|
204
|
+
# Optional extras: tray icon, voice activity detection
|
|
205
|
+
uv pip install -e ".[tray,vad]"
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Reproducible builds and release artifacts
|
|
209
|
+
|
|
210
|
+
Contributors and CI use the committed `uv.lock` with Python 3.12:
|
|
211
|
+
|
|
212
|
+
```powershell
|
|
213
|
+
uv sync --locked --python 3.12 --extra dev --extra runtime --extra tray
|
|
214
|
+
uv run --no-sync ruff check .
|
|
215
|
+
uv run --no-sync ruff format --check .
|
|
216
|
+
uv run --no-sync pytest -m "not gpu and not mic"
|
|
217
|
+
uv build --out-dir dist/packages
|
|
218
|
+
uv run --no-sync python packaging/smoke.py --packages dist/packages
|
|
219
|
+
packaging\build.bat
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
CI reuses the same verification jobs for PRs and tag releases. It uploads a wheel,
|
|
223
|
+
sdist, and full Windows x64 desktop ZIP (runtime and tray dependencies included;
|
|
224
|
+
optional TEN VAD, models and NVIDIA CUDA libraries are not bundled). Package checks
|
|
225
|
+
install both archives with `uv tool install` into temporary tool environments;
|
|
226
|
+
the desktop ZIP is extracted and checked outside the checkout. Checks cover CLI,
|
|
227
|
+
packaged defaults, and desktop dependency imports, not live audio/GPU/UI behavior.
|
|
228
|
+
`--doctor` and `--selftest` remain manual hardware diagnostics, not CI gates.
|
|
229
|
+
|
|
230
|
+
To install a downloaded wheel as a desktop tool without cloning the repository:
|
|
231
|
+
|
|
232
|
+
```powershell
|
|
233
|
+
uv tool install --python 3.12 "C:\path\to\kural-0.1.0-py3-none-any.whl[runtime,tray]"
|
|
234
|
+
kural --version
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
After `cmd-kural` 0.1.2 has been published to PyPI, install it as a CLI tool:
|
|
238
|
+
|
|
239
|
+
```powershell
|
|
240
|
+
uv tool install --python 3.12 --from "cmd-kural[runtime,tray]" kural
|
|
241
|
+
kural --version
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
The PyPI distribution is named `cmd-kural`; the installed CLI and Python import stay `kural`. **This PyPI package is not published yet**, so the command above cannot be used until the `cmd-kural` 0.1.2 upload completes. The existing `kural` PyPI project belongs to an unrelated package; the owner must claim `cmd-kural` and configure its Trusted Publisher before the gated OIDC workflow can publish. Until then, use the [v0.1.0 GitHub Release wheel](https://github.com/mdaashir/kural/releases/download/v0.1.0/kural-0.1.0-py3-none-any.whl).
|
|
245
|
+
|
|
246
|
+
GitHub Releases run only when an existing `v<project.version>` tag is pushed; the tag must
|
|
247
|
+
match `pyproject.toml` exactly. Verified desktop and Python artifacts are attached there.
|
|
248
|
+
PyPI publishing uses the separate manual `.github/workflows/publish-pypi.yml` workflow and
|
|
249
|
+
is disabled unless repository variable `PUBLISH_PYPI=true`. Before enabling it, claim
|
|
250
|
+
`cmd-kural` on PyPI, configure the exact trusted publisher and protected GitHub `pypi`
|
|
251
|
+
environment, and verify the publisher is active. It uses OIDC only; no API token is used,
|
|
252
|
+
and pull requests never publish. See [RELEASE.md](RELEASE.md) for exact PyPI setup steps.
|
|
253
|
+
|
|
254
|
+
### Running Kural
|
|
255
|
+
|
|
256
|
+
```powershell
|
|
257
|
+
# Start the live dictation daemon
|
|
258
|
+
python -m kural
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
```
|
|
262
|
+
=======================================================
|
|
263
|
+
Kural 0.1.0 — Ready
|
|
264
|
+
=======================================================
|
|
265
|
+
[Ctrl+Space] Dictation Mode (speech → active cursor)
|
|
266
|
+
[Ctrl+Shift+Space] Command Mode (voice control)
|
|
267
|
+
Model: large-v3-turbo (cuda)
|
|
268
|
+
Press Ctrl+C to exit.
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
An animated soundwave equalizer pill appears at the screen edge while you speak, showing a live
|
|
272
|
+
mic level. The pill is click-through so it never blocks your mouse. A soft bell chime plays when
|
|
273
|
+
recording starts and when text is delivered.
|
|
274
|
+
|
|
275
|
+
### System Health Check
|
|
276
|
+
|
|
277
|
+
Verify hardware, CUDA libraries, audio setup, and configuration:
|
|
278
|
+
|
|
279
|
+
```powershell
|
|
280
|
+
python -m kural --doctor
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Expected output:
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
Kural — Doctor Diagnostics
|
|
287
|
+
============================
|
|
288
|
+
|
|
289
|
+
Runtime
|
|
290
|
+
[OK] Python version 3.12.x (target 3.12+)
|
|
291
|
+
[i] Platform Windows 11 (AMD64)
|
|
292
|
+
[OK] Kural version 0.1.0
|
|
293
|
+
|
|
294
|
+
Hardware & GPU (Target: NVIDIA RTX 3050)
|
|
295
|
+
[OK] Detected GPU NVIDIA GeForce RTX 3050 (nvidia)
|
|
296
|
+
[OK] CUDA runtime v12.x
|
|
297
|
+
[OK] CUDA inference libraries cuBLAS & cuDNN available
|
|
298
|
+
|
|
299
|
+
Dependencies
|
|
300
|
+
[OK] numpy installed
|
|
301
|
+
[OK] faster_whisper v1.x
|
|
302
|
+
...
|
|
303
|
+
|
|
304
|
+
Configuration
|
|
305
|
+
[OK] Config directory C:\Users\<you>\AppData\Roaming\kural
|
|
306
|
+
[OK] Config integrity All settings valid
|
|
307
|
+
[i] Selected model large-v3-turbo on cuda (float16)
|
|
308
|
+
|
|
309
|
+
Audio & Microphone
|
|
310
|
+
[OK] Default microphone <Microphone Name> (48000 Hz)
|
|
311
|
+
[OK] Voice activity detection TEN VAD ready
|
|
312
|
+
|
|
313
|
+
Model Cache
|
|
314
|
+
[OK] Idle VRAM unload 5 min timeout (frees GPU memory)
|
|
315
|
+
[OK] Model 'large-v3-turbo' cached
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## Usage
|
|
321
|
+
|
|
322
|
+
### Dictation
|
|
323
|
+
|
|
324
|
+
| Mode | Hotkey | Action |
|
|
325
|
+
|---|---|---|
|
|
326
|
+
| Dictation | `Ctrl+Space` | Toggle (or hold in push-to-talk mode) |
|
|
327
|
+
| Command | `Ctrl+Shift+Space` | Voice control |
|
|
328
|
+
| Cancel | `Escape` | Discard active recording without transcribing or delivering it |
|
|
329
|
+
| Paste Last | Tray menu / `Ctrl+Alt+V` | Re-type last non-Incognito dictation at the active cursor |
|
|
330
|
+
| Retry Last | Tray menu | Re-transcribe the retained audio take when Incognito is off |
|
|
331
|
+
| Incognito | Tray menu | Disable history, learning, audio retention, and ledger/Paste Last retention |
|
|
332
|
+
|
|
333
|
+
**Push-to-Talk variants:**
|
|
334
|
+
- **Keyboard hotkey** – hold `Ctrl+Space` while speaking
|
|
335
|
+
- **Multi-key chord** – configure any combo like `ctrl+windows` or `ctrl+alt` via settings
|
|
336
|
+
- **Mouse Flow** – hold thumb button (`x1`, `x2`, or middle click) while speaking; button's default Windows action (browser Back/Forward) is suppressed during dictation
|
|
337
|
+
|
|
338
|
+
**Double-tap to lock hands-free:** tap the hotkey twice quickly (<450 ms) to stay in hands-free mode — tap once more to stop.
|
|
339
|
+
|
|
340
|
+
**Text delivery methods:**
|
|
341
|
+
- `paste` (default): copies to clipboard and sends `Ctrl+V`, then restores the prior clipboard.
|
|
342
|
+
- `type`: injects each character directly via Win32 `SendInput` KEYEVENTF_UNICODE — works in paste-blocked apps such as VMs, remote desktops, and games.
|
|
343
|
+
- `copy`: copies the formatted transcript to the clipboard without sending keystrokes to the foreground app.
|
|
344
|
+
|
|
345
|
+
### Voice Commands
|
|
346
|
+
|
|
347
|
+
Kural recognizes commands in English, formal Tamil, and colloquial Tanglish:
|
|
348
|
+
|
|
349
|
+
| Action | English | Tamil | Tanglish |
|
|
350
|
+
|---|---|---|---|
|
|
351
|
+
| **Launch App** | *"open chrome"* | *"திற குரோம்"* / *"குரோம் திற"* | *"chrome open பண்ணு"* |
|
|
352
|
+
| **Close App** | *"close notepad"* | *"மூடு நோட்பேடு"* | *"notepad close பண்ணு"* |
|
|
353
|
+
| **Switch Window** | *"switch to edge"* | *"எட்ஜ்-க்கு போ"* | *"edge-க்கு மாற்று"* |
|
|
354
|
+
| **Volume Up** | *"volume up"* | *"சத்தம் ஏற்று"* | *"sound ஏத்து"* |
|
|
355
|
+
| **Volume Down** | *"volume down"* | *"சத்தம் குறை"* | *"sound குறை"* |
|
|
356
|
+
| **Mute Audio** | *"mute"* | *"ஒலியை நிறுத்து"* | *"மியூட் பண்ணு"* |
|
|
357
|
+
| **Media Play/Pause** | *"play"* / *"pause"* | *"பாடலை இயக்கு"* | *"play பண்ணு"* |
|
|
358
|
+
| **Window Snap** | *"snap left"* | *"இடதுபக்கம் மாற்று"* | *"snap left பண்ணு"* |
|
|
359
|
+
| **Show Desktop** | *"show desktop"* | *"டெஸ்க்டாப் காட்டு"* | *"desktop காட்டு"* |
|
|
360
|
+
| **Web Search** | *"search for python"* | *"பைதான் பற்றி தேடு"* | *"python தேடு"* |
|
|
361
|
+
| **YouTube Search** | *"search lofi on youtube"* | *"ரஜினி பாடல் யூடியூபில் தேடு"* | *"lofi youtube-ல தேடு"* |
|
|
362
|
+
|
|
363
|
+
### Smart Text Features
|
|
364
|
+
|
|
365
|
+
- **Disfluency cleaning:** removes *um*, *uh*, false-start duplicates before delivery.
|
|
366
|
+
- **Spoken punctuation:** *"full stop"* → `.`, *"புள்ளி"* → `.`
|
|
367
|
+
- **Voice rewrites:** *"make it a bullet list"*, *"title case"*, *"camelCase"*, *"snake_case"*
|
|
368
|
+
- **Voice editing:** *"replace error with issue"*, *"sort lines"*, code formatting transforms
|
|
369
|
+
- **Snippet expansion:** `${date}`, `${time}`, `${clipboard}` variables; `mode: anywhere` (default) expands inline, while `mode: alone` expands only when the full normalized dictation matches the trigger
|
|
370
|
+
- **Custom dictionary:** `kural --dict-add "Aashir"` — hotwords preserved during transcription
|
|
371
|
+
- **Adaptive vocabulary:** corrections and context learned on-disk session by session
|
|
372
|
+
- **Whisper Mode:** adaptive gain boost for quiet or whispered speech (99.9th percentile pop rejection)
|
|
373
|
+
- **Output Audio Ducking:** automatically lowers music/video playback volume while speaking so speakers don't bleed into the mic (Hex-inspired)
|
|
374
|
+
- **Instant Cancel Hotkey (`Escape`):** aborts dictation or voice control immediately and discards audio buffer without typing or logging (Hex-inspired)
|
|
375
|
+
- **Voice Stop Phrase:** say *"stop dictation"* or *"முடி"* / *"stop பண்ணு"* to automatically finalize hands-free dictation without pressing hotkeys (Hex-inspired)
|
|
376
|
+
- **Windows Clipboard History Retention:** optionally keep dictations in Windows Clipboard History (`Win+V`) instead of restoring prior clipboard (Hex-inspired)
|
|
377
|
+
- **Return to App:** attempts to refocus the original window before applying its app formatting/suppression rule; if Kural cannot confirm it is foreground, paste/type is withheld and the transcript is offered in the fallback window (Hex-inspired).
|
|
378
|
+
|
|
379
|
+
### Offline Audio File Transcription (`--transcribe`)
|
|
380
|
+
|
|
381
|
+
Inspired by [`anomalyco/hex`](https://github.com/anomalyco/hex), Kural can transcribe recorded audio files directly from the command line on your local GPU without running the background live dictation daemon:
|
|
382
|
+
|
|
383
|
+
```powershell
|
|
384
|
+
# Plain text transcription to stdout
|
|
385
|
+
python -m kural --transcribe meeting.wav
|
|
386
|
+
|
|
387
|
+
# Transcribe Tamil voice note and save SubRip (.srt) subtitles
|
|
388
|
+
python -m kural --transcribe recording.wav --format srt --output subtitles.srt
|
|
389
|
+
|
|
390
|
+
# Structured JSON export with timestamps and segments
|
|
391
|
+
python -m kural --transcribe audio.wav --format json --output transcript.json
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### Local OpenAI-Compatible Transcription API
|
|
395
|
+
|
|
396
|
+
Kural can serve transcription requests locally on `127.0.0.1` using the configured Whisper model:
|
|
397
|
+
|
|
398
|
+
```powershell
|
|
399
|
+
# Start the local API server (default port 7777)
|
|
400
|
+
python -m kural --serve
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
Available endpoints:
|
|
404
|
+
|
|
405
|
+
| Method | Path | Description |
|
|
406
|
+
|---|---|---|
|
|
407
|
+
| `GET` | `/health` | Local server health check |
|
|
408
|
+
| `GET` | `/v1/models` | OpenAI-compatible model list |
|
|
409
|
+
| `POST` | `/v1/audio/transcriptions` | Multipart audio transcription |
|
|
410
|
+
|
|
411
|
+
The POST endpoint requires a multipart `file` field. Optional fields include `language`, `prompt`, and `response_format`. Response formats are `json` (default, `{"text":"..."}`) and `text`; other values are rejected with HTTP 400. Malformed or incomplete multipart requests and undecodable audio return HTTP 400; transcription failures return HTTP 500 with a JSON error. Audio is decoded to mono 16 kHz; `soundfile` handles supported audio formats when installed, with standard PCM WAV fallback support for 16-, 24-, and 32-bit WAV. Upload bodies are limited to 500 MiB, and truncated bodies or malformed multipart framing are rejected.
|
|
412
|
+
|
|
413
|
+
```powershell
|
|
414
|
+
curl.exe -X POST http://127.0.0.1:7777/v1/audio/transcriptions `
|
|
415
|
+
-F "file=@meeting.wav" `
|
|
416
|
+
-F "language=ta" `
|
|
417
|
+
-F "response_format=json"
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### Benchmarks
|
|
421
|
+
|
|
422
|
+
Run the ASR benchmark harness to measure latency (RTF) and error rates (WER, Tamil CER):
|
|
423
|
+
|
|
424
|
+
```powershell
|
|
425
|
+
python -m benchmarks.run --models large-v3-turbo --device cuda --compute-type float16
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
### Building Packages and Standalone Executable
|
|
429
|
+
|
|
430
|
+
#### 1. Python Package Distributions (Wheel & sdist)
|
|
431
|
+
|
|
432
|
+
```powershell
|
|
433
|
+
uv build
|
|
434
|
+
```
|
|
435
|
+
Outputs: `dist/kural-0.1.0-py3-none-any.whl` and `dist/kural-0.1.0.tar.gz`.
|
|
436
|
+
|
|
437
|
+
#### 2. Standalone Windows Desktop App & Setup Installer
|
|
438
|
+
|
|
439
|
+
```cmd
|
|
440
|
+
packaging\build.bat
|
|
441
|
+
```
|
|
442
|
+
Output:
|
|
443
|
+
- `dist\kural\kural.exe` — a self-contained Windows application bundle with bundled configurations and no Python runtime installation required.
|
|
444
|
+
- `dist\kural-windows-x64.zip` — portable archive ready to unzip and run anywhere.
|
|
445
|
+
- `dist\kural-windows-x64-setup.exe` — per-user setup wizard installer (built with Inno Setup, lowest privileges, no admin rights required).
|
|
446
|
+
|
|
447
|
+
#### 3. Automated CI / CD & Releases
|
|
448
|
+
|
|
449
|
+
- **Continuous Integration (`.github/workflows/ci.yml`):** Runs on every push and pull request to `main`. Checks Ruff formatting, lints the codebase, executes all 579 offline unit tests, verifies package metadata (`twine check`), builds wheel/sdist distributions with smoke tests outside the repo, compiles the standalone desktop bundle, and smoke-tests both the portable `kural.exe` and silent installer.
|
|
450
|
+
- **Release Automation (`.github/workflows/release.yml`):** Triggered on version tags (`v*.*.*`) or via manual dispatch with a validated existing tag. Validates tag ancestry against `main`, executes the verified build pipeline, verifies the complete artifact set, generates cryptographically verified `SHA256SUMS`, creates an official GitHub Release with all binary assets attached, and optionally publishes to PyPI when trusted publishing is enabled. See [RELEASE.md](RELEASE.md) for maintainer procedures and [CHANGELOG.md](CHANGELOG.md) for full version history.
|
|
451
|
+
|
|
452
|
+
---
|
|
453
|
+
|
|
454
|
+
## Running Tests
|
|
455
|
+
|
|
456
|
+
All unit tests run 100% offline — no microphone, GPU, or network download required:
|
|
457
|
+
|
|
458
|
+
```powershell
|
|
459
|
+
# Run the complete offline test suite
|
|
460
|
+
pytest tests/ -q
|
|
461
|
+
|
|
462
|
+
# Code style and format checks
|
|
463
|
+
ruff check .
|
|
464
|
+
ruff format --check .
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
---
|
|
468
|
+
|
|
469
|
+
## Configuration
|
|
470
|
+
|
|
471
|
+
User settings live in `%APPDATA%\kural\user_settings.yaml`. Key sections:
|
|
472
|
+
|
|
473
|
+
| Section | Key | Default | Notes |
|
|
474
|
+
|---|---|---|---|
|
|
475
|
+
| `whisper` | `model` | `large-v3-turbo` | Whisper model variant |
|
|
476
|
+
| `whisper` | `device` | `cuda` | `cuda` or `cpu` |
|
|
477
|
+
| `whisper` | `idle_unload_minutes` | `5` | 0 = never unload |
|
|
478
|
+
| `hotkey` | `recording_hotkey` | `ctrl+space` | Dictation toggle |
|
|
479
|
+
| `hotkey` | `command_hotkey` | `ctrl+shift+space` | Command toggle |
|
|
480
|
+
| `hotkey` | `mouse_button` | `` (disabled) | `x1`, `x2`, `both`, `middle` |
|
|
481
|
+
| `hotkey` | `recording_mode` | `toggle` | `toggle` or `push_to_talk` |
|
|
482
|
+
| `clipboard` | `delivery_method` | `paste` | `paste` or `type` |
|
|
483
|
+
| `audio` → `whisper_mode` | `enabled` | `true` | Quiet speech boost |
|
|
484
|
+
| `overlay` | `position` | `bottom-center` | Pill position |
|
|
485
|
+
|
|
486
|
+
All settings can be changed via the **Settings** dialog (tray → Settings...) without editing YAML directly.
|
|
487
|
+
|
|
488
|
+
---
|
|
489
|
+
|
|
490
|
+
## Privacy & Safety
|
|
491
|
+
|
|
492
|
+
| Guarantee | Detail |
|
|
493
|
+
|---|---|
|
|
494
|
+
| **No telemetry** | Zero runtime network calls; only the one-time model download |
|
|
495
|
+
| **Transcript privacy** | Transcribed text is never logged at INFO level or transmitted anywhere |
|
|
496
|
+
| **Incognito Mode** | Disables history.jsonl writes, adaptive learning, DPAPI audio retention, and in-memory ledger/Paste Last retention; entering Incognito clears the prior take and ledger |
|
|
497
|
+
| **Audio retention** | DPAPI-encrypted, single take, 24 h expiry, wiped in Incognito |
|
|
498
|
+
| **Destructive action block** | File deletion, partition format, purchases blocked; shutdown/restart need 60 s cancel window |
|
|
499
|
+
| **Elevated window UIPI** | Detects and warns when target app runs as Administrator instead of silently failing |
|
|
500
|
+
|
|
501
|
+
---
|
|
502
|
+
|
|
503
|
+
## Attribution & Licenses
|
|
504
|
+
|
|
505
|
+
Kural is open-source under the [MIT License](LICENSE). It merges and adapts components from:
|
|
506
|
+
- **`drajb/whisper-local`** (fork of Pin Wang's `whisper-key-local`) — GPU engine, onboarding, doctor, settings
|
|
507
|
+
- **`ROHITCRAFTSYT/WhispLocal`** (by Rohit Burani) — voice-control engine, app index, fuzzy matching, guardrails, adaptive learning, recovery
|
|
508
|
+
- **`anomalyco/hex`** (by Christopher Langton) — audio ducking, file transcription CLI, stop phrases, cancel shortcuts, window focus return, clipboard retention
|
|
509
|
+
|
|
510
|
+
All upstream copyright lines are preserved in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
kural/__init__.py,sha256=IodlGA4OIxsWZdKBHGmn6WNUpywmYfFqxB-JWw-6bMw,98
|
|
2
|
+
kural/__main__.py,sha256=FMUKazIJGtMOLccsVXqHLCDyCOLkzbKxFco0mbhYQfg,11185
|
|
3
|
+
kural/doctor.py,sha256=qMUTLO8iaSFPdOj8WZVlU254UGff5iNkorGcDr_BeOU,10743
|
|
4
|
+
kural/runtime.py,sha256=Qr7Uy2yILFrCFqOGBTQE12_8pTGYCdQi6ERZ460tTXY,36488
|
|
5
|
+
kural/selftest.py,sha256=eATFv9o_D6-xMu5U4KtTwYfNTxAgqPQH2zu9VI1fZQk,7157
|
|
6
|
+
kural/config/__init__.py,sha256=N_38WwceQrDlRTRMgPORlt81Wjcy_qJukbdbVSy5XIQ,382
|
|
7
|
+
kural/config/app_rules.defaults.yaml,sha256=0q9KCTniy2hOScyD-ubgYgVMg_ReQjUk26SUXIQUvUU,1997
|
|
8
|
+
kural/config/commands.defaults.yaml,sha256=JLmJOEq7yasS9eDC7ONWaLXbe2crNRGO_B5n2FqSEu4,2199
|
|
9
|
+
kural/config/config.defaults.yaml,sha256=HF7FOR6OuyWVmPz-XVymYkf9HQp417GYk8YX3WcBz24,6881
|
|
10
|
+
kural/config/config_manager.py,sha256=GKks4G9pNhlsPAWoUQmqOM9eOZ4vt5b9GKeYhY6Vep0,22183
|
|
11
|
+
kural/config/configcheck.py,sha256=gTIFa8gsCLe_hoAs0qVirPFujFNFu-UjcN7spZwdLrQ,9306
|
|
12
|
+
kural/config/defaults_merge.py,sha256=3AGmPt9JAxUJ31CfhIewhvRi_VG6FQ5J5v9QwXDsvvY,10476
|
|
13
|
+
kural/control/__init__.py,sha256=1PGnf8XZGmR6-IdqoZ4mhzv5enMEEr4mFTQawuXh1MU,2135
|
|
14
|
+
kural/control/app_index.py,sha256=x4PyvpitIIaloaYDt97DsImTgk-tYlBdkH9a_Y6mpro,10213
|
|
15
|
+
kural/control/app_rules.py,sha256=gpAdqa5-nWhUjCg03vNiFGkFQs3gmfFiTAC3I4MQPvc,4650
|
|
16
|
+
kural/control/autostart.py,sha256=xZuWqb8RME7ml7Wur7B0AbB0lXaovg7YhYPbl_MyJFs,4048
|
|
17
|
+
kural/control/chords.py,sha256=goNtTDtknlaCT5QRrMZfCz5hbNmnmG1JCniCVUjZkG8,3289
|
|
18
|
+
kural/control/executor.py,sha256=0c1nNWyu01ldfjDHCPJ3PgJCLL15g_qEq-7gchO9Jg4,15075
|
|
19
|
+
kural/control/guardrails.py,sha256=DKotjvKQqMkA6lI24AOsW8mZVYR4d8lN7dlp5zyWwG4,5859
|
|
20
|
+
kural/control/llm_fallback.py,sha256=WQ6Exr5oQHN_f_WL7uQOLP7cy4AqXABPjT3xONgHsLE,5012
|
|
21
|
+
kural/control/media.py,sha256=acs-69gRT0qziawDgcRhwFhyr1cETJunN67gWo7eplA,6840
|
|
22
|
+
kural/control/mouse.py,sha256=BjE6pFSsCMVt0sc2TMk72e_Wqz_RNTwpMOz22pElnm4,6869
|
|
23
|
+
kural/control/parser.py,sha256=cy3fJdjJ9vNIjDmQyseAwl3xGe_Vy8pUUCV4LVD9JDs,17849
|
|
24
|
+
kural/control/planner.py,sha256=Wd-eDW7SffGOtOrSZJU1xkN4jGvYiqhFRVz6GARikLA,6127
|
|
25
|
+
kural/control/windows.py,sha256=snaypItORb5MW18DzdH4zHYbU4uqpr4X6mLiP5rT3UM,20930
|
|
26
|
+
kural/engine/__init__.py,sha256=xvSGe0K12OB67OVfh5frp8TA56UIS0k2IaAKQEgW-zM,239
|
|
27
|
+
kural/engine/adaptive.py,sha256=YR3AIANRQyxZQVsgzZ6k0TS-AnlrXiaG3_t0jDO7b40,6504
|
|
28
|
+
kural/engine/audio_ducking.py,sha256=8CP858uCJYq34PTCcQ_4Df7G5l9JxxV4RAeTI-WZ0bA,4273
|
|
29
|
+
kural/engine/audio_feedback.py,sha256=lOCN0ZYH4GA27FBK8zZnxdWQnFyqmM4TBhELIO1en-w,4833
|
|
30
|
+
kural/engine/audio_gain.py,sha256=j464fouj6PuxkZWT8ZYTLdtql9oM9qzfGfLDd76AI0s,1631
|
|
31
|
+
kural/engine/audio_recorder.py,sha256=WBo_LKCyjYo1tZ7bsBUHowygZtIE6Lxzj8I4Dvgkb3E,22405
|
|
32
|
+
kural/engine/bundle_logs.py,sha256=8LtnUrykbWvIoYpbzsvNEGzayxBV__507f2VVNFql5I,6646
|
|
33
|
+
kural/engine/cues.py,sha256=pkSypcdTgoZigL2Gorm0kq2DU1jSDBq6Ka7iLgxNv0s,3173
|
|
34
|
+
kural/engine/dictation_cleanup.py,sha256=D9ZIHX63vH5azLvGZkDI-uz6z572jpihpuyKZT30cvI,13826
|
|
35
|
+
kural/engine/dictation_languages.py,sha256=9RzTW1RhlgUgMir-CY7LU5Vv0w0r9v0yTFfRyMbWdNk,3370
|
|
36
|
+
kural/engine/dictionary.py,sha256=RSqRcAzmJ3kNVHJ5PANZ2kHx6VneBtaBelorus7Qzds,3122
|
|
37
|
+
kural/engine/file_transcriber.py,sha256=rXRS9FDORS0CUA3yZ7FFDv7J4pLKz4Gz-9vyjRMBISg,11497
|
|
38
|
+
kural/engine/flow_formatting.py,sha256=DP7zldtBOd-UGlDlwR0WZiEYr8Uw3iGM4Y6meH91zDc,4571
|
|
39
|
+
kural/engine/hardware_detection.py,sha256=ZBdW0UzFvG9BdFrYWSTVJC26gsoI5WOoSkkYbJAz7fc,7198
|
|
40
|
+
kural/engine/history.py,sha256=iAwgD0jQPDsdKE7kiqQIY6CKBLi1IXZZNfqqtT5j52k,6230
|
|
41
|
+
kural/engine/instance_manager.py,sha256=IrOO6eNAs5ev7dIs8Hh6xlO-wOXVznjJ-KH3AkF3wMA,5096
|
|
42
|
+
kural/engine/log_setup.py,sha256=qO7xzruxVqP0f_07G6KlZfYI__rQl5rxXudfv678jVs,3193
|
|
43
|
+
kural/engine/model_registry.py,sha256=RfK6j1NjYMx2Xf3tPKU5u_DkV3XiHrSryx-1AvB3_sE,7199
|
|
44
|
+
kural/engine/model_transfer.py,sha256=3nBqJ9SS22dCIUezz2x2I9bF0cnPvzQLJssLyFjGHis,9706
|
|
45
|
+
kural/engine/noise_suppression.py,sha256=txDDazmDWwMXoXLtypalMUjv-gpp_9oE4s5i9FTDZW0,1869
|
|
46
|
+
kural/engine/notes.py,sha256=RYlLxdFoJCxnDsXBUluNUzWcV01yHb73_yo2L3TFm1c,2854
|
|
47
|
+
kural/engine/recovery.py,sha256=3quPq8K5rUz3HMXQUnC44YPlAMaQfpPKTnbxDpdQfxY,7273
|
|
48
|
+
kural/engine/server.py,sha256=fXWJFLc-h5tIelieI5O97dfcuZRFbNEorf94MBPWxpw,12132
|
|
49
|
+
kural/engine/snippets.py,sha256=RkcbVKXmKILIZSogyERMPWm6oNuv4ziyd-AoVKPLQ9w,3594
|
|
50
|
+
kural/engine/stop_phrase.py,sha256=OZi2CkdwCUE1dqk5z2qqEP7VHAaHoy1zHAyJNA1KLiE,2698
|
|
51
|
+
kural/engine/streaming.py,sha256=-DZGa8mdlYRHADn-bJUa_g2d1YrXhZYEEt7fqwjFr9s,4112
|
|
52
|
+
kural/engine/streaming_delivery.py,sha256=F3CgsESFWLZXZmO-Yy4DI9lR8g-jXt8r0rSMekgeyoQ,5050
|
|
53
|
+
kural/engine/streaming_manager.py,sha256=seavzwOoPiSb3EhPea-TNR2bt71Apk5fQTQ7NU1YeXo,4500
|
|
54
|
+
kural/engine/streaming_recognizer.py,sha256=odIh1N2EsETlhrVpUevamO5rxQXMYVH9spgAYs1vn7o,5881
|
|
55
|
+
kural/engine/transforms.py,sha256=k1cFIlLZ-boVFt9hswb5VDf5Vt9ACSUPEHBwScwkuSo,9822
|
|
56
|
+
kural/engine/utils.py,sha256=h5dnoHh9L2-5Kf_NHR_EiRKa3r2rTuhTb9Jfw9enr8A,11444
|
|
57
|
+
kural/engine/voice_activity_detection.py,sha256=SZWEKItvaFhoNZ-OtxPJ-RSSv1_G-y2jvCsvirEAuQo,13123
|
|
58
|
+
kural/engine/wake_word.py,sha256=ZT27nGpB6rKiht7QCEJprueYxC8PQBOSLGCAxGf24M4,2877
|
|
59
|
+
kural/engine/whisper_engine.py,sha256=dQH2qtU_qX0neaWp2w9atVbqtOGla0FFiqQSPGkjiSM,16970
|
|
60
|
+
kural/ui/__init__.py,sha256=LYJauGFdF89Vz4UXwXWuAkBf0Pm0Fh0n1NBixXXNxI8,398
|
|
61
|
+
kural/ui/cheat_sheet.py,sha256=tbJi__Di1hT4lEBOK8rdFCc46uFsuWz4hjAoxZniQK8,8415
|
|
62
|
+
kural/ui/fallback_window.py,sha256=Je9Wl6fvlWUdIR4EonYNhelsBb3cASCqohARcwxj864,7778
|
|
63
|
+
kural/ui/history_window.py,sha256=jpD9gtyGCLAqPSPY5SaBVsoEKbKH4EXhyaKs6441x4I,8859
|
|
64
|
+
kural/ui/overlay.py,sha256=2L9JydVxlkBFIAjGkaPtI8SyvA3Hf-hbwiWkOb8n_rY,11211
|
|
65
|
+
kural/ui/settings_window.py,sha256=IS7REScyYMqZotdKIhFihXx66LjOv0lEcEMyYip-5wk,21588
|
|
66
|
+
kural/ui/terminal_title.py,sha256=pFG3MYaXEaa4ktk6oiRGSqJkibF3QT88hZ8iPr0_eps,5371
|
|
67
|
+
kural/ui/tray.py,sha256=ke_SKVWnFegn6IfM8iuKZTCLOuuLTmpHmV5Clmd9W9A,6290
|
|
68
|
+
cmd_kural-0.1.2.dist-info/METADATA,sha256=LwOGV8Y6nFecmwc5cK9FYY1CCOGCJob8uFX4H9FtsHw,28409
|
|
69
|
+
cmd_kural-0.1.2.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
|
|
70
|
+
cmd_kural-0.1.2.dist-info/entry_points.txt,sha256=HYTyFyJmQELyhHpxsfbeDRxObKw5lr3pSzk-01AhcKM,46
|
|
71
|
+
cmd_kural-0.1.2.dist-info/licenses/LICENSE,sha256=bqfVD-c8ZV1etP5KHe5KqRPjgL56-JQdlWRBxVwa55M,1466
|
|
72
|
+
cmd_kural-0.1.2.dist-info/RECORD,,
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Mohamed Aashir S
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
This project incorporates code from the following MIT-licensed sources:
|
|
26
|
+
|
|
27
|
+
drajb/whisper-local (fork of Pin Wang's whisper-key-local)
|
|
28
|
+
Copyright (c) Pin Wang
|
|
29
|
+
Copyright (c) drajb contributors
|
|
30
|
+
MIT License — see THIRD_PARTY_NOTICES.md
|
|
31
|
+
|
|
32
|
+
ROHITCRAFTSYT/WhispLocal
|
|
33
|
+
Copyright (c) Rohit Burani / ROHITCRAFTSYT
|
|
34
|
+
MIT License — see THIRD_PARTY_NOTICES.md
|
kural/__init__.py
ADDED