# cjm-transcription-plugin-whisper
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Install
``` bash
pip install cjm_transcription_plugin_whisper
```
## Project Structure
nbs/
└── plugin.ipynb # Plugin implementation for OpenAI Whisper transcription
Total: 1 notebook across 1 directory
## Module Dependencies
``` mermaid
graph LR
plugin[plugin<br/>Whisper Plugin]
```
No cross-module dependencies detected.
## CLI Reference
No CLI commands found in this project.
## Module Overview
Detailed documentation for each module in the project:
### Whisper Plugin (`plugin.ipynb`)
> Plugin implementation for OpenAI Whisper transcription
#### Import
``` python
from cjm_transcription_plugin_whisper.plugin import (
WhisperLocalPlugin
)
```
#### Classes
``` python
class WhisperLocalPlugin:
def __init__(self):
"""Initialize the Whisper plugin with default configuration."""
self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
self.config = {}
self.model = None
self.device = None
self.model_dir = None
@property
def name(
self
) -> str: # Returns the plugin name
"OpenAI Whisper transcription plugin."
def __init__(self):
"""Initialize the Whisper plugin with default configuration."""
self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
self.config = {}
self.model = None
self.device = None
self.model_dir = None
@property
def name(
self
) -> str: # Returns the plugin name
"Initialize the Whisper plugin with default configuration."
def name(
self
) -> str: # Returns the plugin name
"Get the plugin name identifier."
def version(
self
) -> str: # Returns the plugin version
"Get the plugin version string."
def supported_formats(
self
) -> List[str]: # Returns list of supported audio formats
"Get the list of supported audio file formats."
def get_config_schema(
self
) -> Dict[str, Any]: # Returns the configuration schema dictionary
"Return configuration schema for Whisper."
def get_current_config(
self
) -> Dict[str, Any]: # Returns the current configuration dictionary
"Return current configuration."
def initialize(
self,
config: Optional[Dict[str, Any]] = None # Configuration dictionary to initialize the plugin
) -> None
"Initialize the plugin with configuration."
def execute(
self,
audio: Union[AudioData, str, Path], # Audio data or path to audio file to transcribe
**kwargs # Additional arguments to override config
) -> TranscriptionResult: # Returns transcription result with text and metadata
"Transcribe audio using Whisper."
def is_available(
self
) -> bool: # Returns True if Whisper and its dependencies are available
"Check if Whisper is available."
def cleanup(
self
) -> None
"Clean up resources."
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cj-mills/cjm-transcription-plugin-whisper",
"name": "cjm-transcription-plugin-whisper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Christian J. Mills",
"author_email": "9126128+cj-mills@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/02/79/36b0baadcae5b36849b115247bcab992c63e39cdc0957a0518c4a4aa8758/cjm_transcription_plugin_whisper-0.0.2.tar.gz",
"platform": null,
"description": "# cjm-transcription-plugin-whisper\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Install\n\n``` bash\npip install cjm_transcription_plugin_whisper\n```\n\n## Project Structure\n\n nbs/\n \u2514\u2500\u2500 plugin.ipynb # Plugin implementation for OpenAI Whisper transcription\n\nTotal: 1 notebook across 1 directory\n\n## Module Dependencies\n\n``` mermaid\ngraph LR\n plugin[plugin<br/>Whisper Plugin]\n```\n\nNo cross-module dependencies detected.\n\n## CLI Reference\n\nNo CLI commands found in this project.\n\n## Module Overview\n\nDetailed documentation for each module in the project:\n\n### Whisper Plugin (`plugin.ipynb`)\n\n> Plugin implementation for OpenAI Whisper transcription\n\n#### Import\n\n``` python\nfrom cjm_transcription_plugin_whisper.plugin import (\n WhisperLocalPlugin\n)\n```\n\n#### Classes\n\n``` python\nclass WhisperLocalPlugin:\n def __init__(self):\n \"\"\"Initialize the Whisper plugin with default configuration.\"\"\"\n self.logger = logging.getLogger(f\"{__name__}.{type(self).__name__}\")\n self.config = {}\n self.model = None\n self.device = None\n self.model_dir = None\n \n @property\n def name(\n self\n ) -> str: # Returns the plugin name\n \"OpenAI Whisper transcription plugin.\"\n \n def __init__(self):\n \"\"\"Initialize the Whisper plugin with default configuration.\"\"\"\n self.logger = logging.getLogger(f\"{__name__}.{type(self).__name__}\")\n self.config = {}\n self.model = None\n self.device = None\n self.model_dir = None\n \n @property\n def name(\n self\n ) -> str: # Returns the plugin name\n \"Initialize the Whisper plugin with default configuration.\"\n \n def name(\n self\n ) -> str: # Returns the plugin name\n \"Get the plugin name identifier.\"\n \n def version(\n self\n ) -> str: # Returns the plugin version\n \"Get the plugin version string.\"\n \n def supported_formats(\n self\n ) -> List[str]: # Returns list of supported audio formats\n \"Get the list of supported audio file formats.\"\n \n def get_config_schema(\n self\n ) -> Dict[str, Any]: # Returns the configuration schema dictionary\n \"Return configuration schema for Whisper.\"\n \n def get_current_config(\n self\n ) -> Dict[str, Any]: # Returns the current configuration dictionary\n \"Return current configuration.\"\n \n def initialize(\n self,\n config: Optional[Dict[str, Any]] = None # Configuration dictionary to initialize the plugin\n ) -> None\n \"Initialize the plugin with configuration.\"\n \n def execute(\n self,\n audio: Union[AudioData, str, Path], # Audio data or path to audio file to transcribe\n **kwargs # Additional arguments to override config\n ) -> TranscriptionResult: # Returns transcription result with text and metadata\n \"Transcribe audio using Whisper.\"\n \n def is_available(\n self\n ) -> bool: # Returns True if Whisper and its dependencies are available\n \"Check if Whisper is available.\"\n \n def cleanup(\n self\n ) -> None\n \"Clean up resources.\"\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "OpenAI Whisper plugin for the cjm-transcription-plugin-system library - provides local speech-to-text transcription with configurable model selection and parameter control.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/cj-mills/cjm-transcription-plugin-whisper"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8ee79afc93d4e230605926ec95ede6ff6ff6855496162b1b1e4be8fc275194f0",
"md5": "30c374a7cd0d4e9f1c558aa98ae30ac0",
"sha256": "a4b98c2101fa722e6091c00048a57bbb511298684ab92d598f6f9b57d8d0c8b4"
},
"downloads": -1,
"filename": "cjm_transcription_plugin_whisper-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30c374a7cd0d4e9f1c558aa98ae30ac0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 12830,
"upload_time": "2025-09-01T19:14:52",
"upload_time_iso_8601": "2025-09-01T19:14:52.173066Z",
"url": "https://files.pythonhosted.org/packages/8e/e7/9afc93d4e230605926ec95ede6ff6ff6855496162b1b1e4be8fc275194f0/cjm_transcription_plugin_whisper-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "027936b0baadcae5b36849b115247bcab992c63e39cdc0957a0518c4a4aa8758",
"md5": "4dca67cbf62c1b0ff910b8642cd16290",
"sha256": "94a404aedc4299e1e95f6042efc1a2a0652681078b3780e9b0ae35ea7f224b79"
},
"downloads": -1,
"filename": "cjm_transcription_plugin_whisper-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4dca67cbf62c1b0ff910b8642cd16290",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13464,
"upload_time": "2025-09-01T19:14:53",
"upload_time_iso_8601": "2025-09-01T19:14:53.395777Z",
"url": "https://files.pythonhosted.org/packages/02/79/36b0baadcae5b36849b115247bcab992c63e39cdc0957a0518c4a4aa8758/cjm_transcription_plugin_whisper-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-01 19:14:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cj-mills",
"github_project": "cjm-transcription-plugin-whisper",
"github_not_found": true,
"lcname": "cjm-transcription-plugin-whisper"
}
JSON
