TranscribeNPy 0.1.2__tar.gz → 1.0.5__tar.gz

{transcribenpy-0.1.2/src/TranscribeNPy.egg-info → transcribenpy-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TranscribeNPy
-Version: 0.1.2
+Version: 1.0.5
 Summary: A Python module for recorded audio transcription via Wispr with groq API
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -28,6 +28,21 @@ import os
 API_KEY = os.environ.get("GROQ_API_KEY")
 audio_path = "samples/audio.wav"
 
-text = transcribe(API_KEY, audio_path)
+text = transcribe(API_KEY, audio_path, model="Precise")
 print(text)
 ```
+
+## Parameters
+
+- `api_key` : String
+    - Groq API Key
+    - Required
+- `filename` : String
+    - Audio file path
+    - Default: "samples/audio.wav"
+- `model` : String
+    - Model to use for transcription
+    - Options: 
+      - "Fast" / "Quick" / "Fastest" / "Turbo" -> "whisper-large-v3-turbo"
+      - "Precise" / "Heavy" / "Slow" -> "whisper-large-v3"
+    - Default: "Fast"

transcribenpy-1.0.5/README.md

@@ -0,0 +1,38 @@
+# TranscribeNPy
+A python module for transcribing audio files to text via Groq's Whisper-Large-v3/Whisper-Large-v3-turbo
+
+## Installation
+```bash
+pip install TranscribeNPy
+```
+or via UV:
+```bash
+uv add TranscribeNPy
+```
+
+## Usage
+```python
+from transcribenpy import transcribe
+import os
+
+API_KEY = os.environ.get("GROQ_API_KEY")
+audio_path = "samples/audio.wav"
+
+text = transcribe(API_KEY, audio_path, model="Precise")
+print(text)
+```
+
+## Parameters
+
+- `api_key` : String
+    - Groq API Key
+    - Required
+- `filename` : String
+    - Audio file path
+    - Default: "samples/audio.wav"
+- `model` : String
+    - Model to use for transcription
+    - Options: 
+      - "Fast" / "Quick" / "Fastest" / "Turbo" -> "whisper-large-v3-turbo"
+      - "Precise" / "Heavy" / "Slow" -> "whisper-large-v3"
+    - Default: "Fast"

{transcribenpy-0.1.2 → transcribenpy-1.0.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "TranscribeNPy"
-version = "0.1.2"
+version = "1.0.5"
 description = "A Python module for recorded audio transcription via Wispr with groq API"
 readme = "README.md"
 requires-python = ">=3.11"

{transcribenpy-0.1.2 → transcribenpy-1.0.5/src/TranscribeNPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TranscribeNPy
-Version: 0.1.2
+Version: 1.0.5
 Summary: A Python module for recorded audio transcription via Wispr with groq API
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -28,6 +28,21 @@ import os
 API_KEY = os.environ.get("GROQ_API_KEY")
 audio_path = "samples/audio.wav"
 
-text = transcribe(API_KEY, audio_path)
+text = transcribe(API_KEY, audio_path, model="Precise")
 print(text)
 ```
+
+## Parameters
+
+- `api_key` : String
+    - Groq API Key
+    - Required
+- `filename` : String
+    - Audio file path
+    - Default: "samples/audio.wav"
+- `model` : String
+    - Model to use for transcription
+    - Options: 
+      - "Fast" / "Quick" / "Fastest" / "Turbo" -> "whisper-large-v3-turbo"
+      - "Precise" / "Heavy" / "Slow" -> "whisper-large-v3"
+    - Default: "Fast"

transcribenpy-1.0.5/src/transcribenpy/core.py

@@ -0,0 +1,44 @@
+import os
+from groq import Groq
+
+def isVaild(api_key):
+    if not api_key or api_key.strip() == "" or len(api_key) < 5:
+        return False
+    return True
+    
+def isFileVaild(filename):
+    if (not os.path.exists(filename)) or (not os.path.isfile(filename)) or filename.strip() == "":
+        return False
+    return True
+
+def getModel(model:str):
+    if model.lower() == "fast" or model.lower() == "quick" or model.lower() == "fastest" or model.lower() == "turbo":
+        return "whisper-large-v3-turbo"
+    elif model.lower() == "precise" or model.lower() == "heavy" or model.lower() == "slow":
+        return "whisper-large-v3"
+    else:
+        return "whisper-large-v3-turbo"
+
+def transcribe(api_key, filename="samples/audio.wav", model="Fast"):
+    if not isVaild(api_key):
+        raise ValueError(f"API Key: {api_key} is invalid")
+    
+    if not isFileVaild(filename):
+        raise ValueError(f"Audio file: {filename} is invalid")
+
+    client = Groq(api_key=api_key)
+    model = getModel(model)
+
+    # Open the audio file
+    with open(filename, "rb") as file:
+        # Create a transcription of the audio file
+        transcription = client.audio.transcriptions.create( # API call
+        file=file, # Required audio file
+        model=model, # Required model to use for transcription
+        )
+        # To print only the transcription text, you'd use print(transcription.text) (here we're printing the entire transcription object to access timestamps)
+        return transcription
+
+if __name__ == "__main__":
+    API_KEY = os.getenv("GROQ_API_KEY")
+    print(transcribe(API_KEY, "samples/audio.wav"))

transcribenpy-0.1.2/README.md

@@ -1,23 +0,0 @@
-# TranscribeNPy
-A python module for transcribing audio files to text via Groq's Whisper-Large-v3/Whisper-Large-v3-turbo
-
-## Installation
-```bash
-pip install TranscribeNPy
-```
-or via UV:
-```bash
-uv add TranscribeNPy
-```
-
-## Usage
-```python
-from transcribenpy import transcribe
-import os
-
-API_KEY = os.environ.get("GROQ_API_KEY")
-audio_path = "samples/audio.wav"
-
-text = transcribe(API_KEY, audio_path)
-print(text)
-```

transcribenpy-0.1.2/src/transcribenpy/core.py

@@ -1,17 +0,0 @@
-import os
-from groq import Groq
-
-def transcribe(api_key: str, filename: str="samples/audio.wav"):
-    
-    client = Groq(api_key=api_key)
-
-    # Open the audio file
-    with open(filename, "rb") as file:
-        # Create a transcription of the audio file
-        transcription = client.audio.transcriptions.create( # API call
-        file=file, # Required audio file
-        model="whisper-large-v3-turbo", # Required model to use for transcription
-        )
-        # To print only the transcription text, you'd use print(transcription.text) (here we're printing the entire transcription object to access timestamps)
-        return transcription
-