speakline 0.1.0__tar.gz

speakline-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VoiceComment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

speakline-0.1.0/PKG-INFO

@@ -0,0 +1,304 @@
+Metadata-Version: 2.4
+Name: speakline
+Version: 0.1.0
+Summary: Record voice and insert as inline code comments across any language and IDE
+Author: VoiceComment Team
+License: MIT
+Project-URL: Homepage, https://github.com/likthvishal/SpeakLine
+Project-URL: Repository, https://github.com/likthvishal/SpeakLine
+Project-URL: Issues, https://github.com/likthvishal/SpeakLine/issues
+Keywords: voice,comments,code,transcription,whisper,developer-tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyaudio>=0.2.13
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: openai-whisper>=20231117
+Requires-Dist: openai>=1.0.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# VoiceComment
+
+**Record voice and insert as inline code comments across any language and IDE.**
+
+Turn your spoken thoughts into well-formatted code comments with a single command. Works with Python, JavaScript, TypeScript, Go, Rust, Java, and more.
+
+![Python](https://img.shields.io/badge/python-3.9+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Status](https://img.shields.io/badge/status-alpha-yellow.svg)
+
+## Features
+
+- **Voice Recording**: Local microphone input with silence detection
+- **Transcription**: Support for Whisper (local) and OpenAI API
+- **Smart Comment Insertion**: Language-aware parser with proper indentation
+- **Multi-Language Support**: Python, JavaScript, TypeScript, Go, Rust, Java, C#, Ruby
+- **Pluggable Backends**: Swap recorders, transcribers, and parsers easily
+- **Flexible API**: CLI, Python package, and programmatic access
+- **Production-Ready**: Type hints, error handling, and comprehensive logging
+
+## Installation
+
+### Prerequisites
+- Python 3.9+
+- PortAudio (for audio recording)
+
+### macOS
+```bash
+brew install portaudio
+```
+
+### Ubuntu/Debian
+```bash
+sudo apt-get install portaudio19-dev
+```
+
+### Windows
+PortAudio is typically bundled. If not, download from [PortAudio Downloads](http://www.portaudio.com/download.html).
+
+### Install Package
+
+```bash
+pip install voicecomment
+```
+
+Or from source (development):
+```bash
+git clone https://github.com/yourusername/voicecomment
+cd voicecomment
+pip install -e .
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Record and insert comment at line 42
+voicecomment record myfile.py 42
+
+# With fixed duration (5 seconds)
+voicecomment record myfile.py 42 --duration 5
+
+# Transcribe without modifying file
+voicecomment transcribe
+
+# Insert comment directly (no recording)
+voicecomment insert myfile.py 42 "This is my comment"
+```
+
+### Python API
+
+```python
+from voicecomment import VoiceCommenter
+
+# Auto-detect language from file extension
+commenter = VoiceCommenter()
+commenter.record_and_insert('myfile.py', line_number=42)
+
+# Or specify language explicitly
+commenter = VoiceCommenter(language='python')
+commenter.record_and_insert('main.py', line_number=15)
+
+# Transcribe only
+text = commenter.transcribe_only()
+print(text)  # "This function calculates factorial recursively"
+
+# Insert into code string (no file I/O)
+code = """
+def factorial(n):
+    return n * factorial(n - 1) if n > 1 else 1
+"""
+updated = commenter.insert_comment_to_string(
+    code,
+    "Base case for recursion",
+    line_number=3
+)
+print(updated)
+```
+
+### Jupyter Notebook
+
+```python
+from voicecomment import VoiceCommenter
+
+commenter = VoiceCommenter(language='python')
+
+# Record and modify cell code
+code_str = """
+def process_data(df):
+    return df.dropna()
+"""
+
+updated = commenter.insert_comment_to_string(
+    code_str,
+    "Remove rows with missing values",
+    line_number=2
+)
+print(updated)
+```
+
+## Architecture
+
+### Core Components
+
+#### 1. **AudioRecorder** (`recorder.py`)
+- `LocalAudioRecorder`: Captures audio from system microphone
+- Supports fixed duration or silence detection
+- Configurable sample rate, channels, and format
+
+#### 2. **Transcriber** (`transcriber.py`)
+Pluggable backends:
+- `WhisperTranscriber`: Local OpenAI Whisper model (no API key needed)
+- `OpenAITranscriber`: OpenAI Whisper API
+- `MockTranscriber`: For testing without audio hardware
+
+```python
+# Use local Whisper
+from voicecomment.transcriber import WhisperTranscriber
+transcriber = WhisperTranscriber(model_size="base")
+
+# Or OpenAI API
+from voicecomment.transcriber import OpenAITranscriber
+transcriber = OpenAITranscriber(api_key="sk-...")
+```
+
+#### 3. **CodeParser** (`parser.py`)
+Language-specific parsers:
+- `PythonParser`: Uses `#` prefix with proper indentation
+- `JavaScriptParser`: Uses `//` prefix
+- `GenericParser`: Configurable fallback for unsupported languages
+
+#### 4. **VoiceCommenter** (`commenter.py`)
+Main orchestration class that ties everything together.
+
+## Advanced Usage
+
+### Custom Transcriber
+
+```python
+from voicecomment import VoiceCommenter
+from voicecomment.transcriber import TranscriberBase
+import numpy as np
+
+class CustomLLMTranscriber(TranscriberBase):
+    def transcribe(self, audio: np.ndarray, sample_rate: int = 16000) -> str:
+        # Your LLM logic here
+        return "custom transcription"
+
+commenter = VoiceCommenter(transcriber=CustomLLMTranscriber())
+commenter.record_and_insert('file.py', line_number=10)
+```
+
+### Custom Audio Config
+
+```python
+from voicecomment import VoiceCommenter, AudioConfig
+
+config = AudioConfig(
+    sample_rate=44100,  # High-quality audio
+    channels=2,         # Stereo
+)
+
+commenter = VoiceCommenter(audio_config=config)
+```
+
+### Integration with IDE Extensions
+
+The Python package can be called from:
+- **VS Code Extension**: Via subprocess or Node.js child process
+- **Vim Plugin**: Via Python 3 interface
+- **Neovim**: Via Python plugin host
+- **Emacs**: Via `python-shell`
+
+Example VS Code extension (snippet):
+```typescript
+const { spawn } = require('child_process');
+
+const proc = spawn('voicecomment', ['record', filepath, lineNumber.toString()]);
+proc.on('close', (code) => {
+  if (code === 0) {
+    vscode.window.showInformationMessage('Comment inserted!');
+  }
+});
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/yourusername/voicecomment
+cd voicecomment
+pip install -e ".[dev]"
+```
+
+### Testing
+
+```bash
+pytest
+pytest --cov  # With coverage
+```
+
+### Code Quality
+
+```bash
+black .
+ruff check .
+mypy voicecomment/
+```
+
+## Supported Languages
+
+| Language | Extension | Comment Prefix |
+|----------|-----------|----------------|
+| Python | `.py`, `.pyw` | `#` |
+| JavaScript | `.js`, `.jsx`, `.mjs` | `//` |
+| TypeScript | `.ts`, `.tsx`, `.mts` | `//` |
+| Go | `.go` | `//` |
+| Rust | `.rs` | `//` |
+| Java | `.java` | `//` |
+| C# | `.cs` | `//` |
+| Ruby | `.rb` | `#` |
+| C/C++ | `.c`, `.cpp`, `.h`, `.hpp` | `//` |
+
+## Roadmap
+
+- [ ] VS Code Extension (official)
+- [ ] Vim/Neovim plugin
+- [ ] Watch mode for automated comment markers
+- [ ] Voice activity detection (VAD)
+- [ ] Conversation-aware transcription (context from file)
+- [ ] Custom prompt engineering for comment style
+- [ ] Analytics dashboard (tracking comment patterns)
+- [ ] LangChain integration for LLM-powered comments
+
+## Contributing
+
+Contributions welcome! Please open an issue or pull request.
+
+## License
+
+MIT License - see [LICENSE](LICENSE)
+
+---
+
+**Built for developers who believe code comments should be as natural as talking.**

speakline-0.1.0/README.md

@@ -0,0 +1,267 @@
+# VoiceComment
+
+**Record voice and insert as inline code comments across any language and IDE.**
+
+Turn your spoken thoughts into well-formatted code comments with a single command. Works with Python, JavaScript, TypeScript, Go, Rust, Java, and more.
+
+![Python](https://img.shields.io/badge/python-3.9+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Status](https://img.shields.io/badge/status-alpha-yellow.svg)
+
+## Features
+
+- **Voice Recording**: Local microphone input with silence detection
+- **Transcription**: Support for Whisper (local) and OpenAI API
+- **Smart Comment Insertion**: Language-aware parser with proper indentation
+- **Multi-Language Support**: Python, JavaScript, TypeScript, Go, Rust, Java, C#, Ruby
+- **Pluggable Backends**: Swap recorders, transcribers, and parsers easily
+- **Flexible API**: CLI, Python package, and programmatic access
+- **Production-Ready**: Type hints, error handling, and comprehensive logging
+
+## Installation
+
+### Prerequisites
+- Python 3.9+
+- PortAudio (for audio recording)
+
+### macOS
+```bash
+brew install portaudio
+```
+
+### Ubuntu/Debian
+```bash
+sudo apt-get install portaudio19-dev
+```
+
+### Windows
+PortAudio is typically bundled. If not, download from [PortAudio Downloads](http://www.portaudio.com/download.html).
+
+### Install Package
+
+```bash
+pip install voicecomment
+```
+
+Or from source (development):
+```bash
+git clone https://github.com/yourusername/voicecomment
+cd voicecomment
+pip install -e .
+```
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Record and insert comment at line 42
+voicecomment record myfile.py 42
+
+# With fixed duration (5 seconds)
+voicecomment record myfile.py 42 --duration 5
+
+# Transcribe without modifying file
+voicecomment transcribe
+
+# Insert comment directly (no recording)
+voicecomment insert myfile.py 42 "This is my comment"
+```
+
+### Python API
+
+```python
+from voicecomment import VoiceCommenter
+
+# Auto-detect language from file extension
+commenter = VoiceCommenter()
+commenter.record_and_insert('myfile.py', line_number=42)
+
+# Or specify language explicitly
+commenter = VoiceCommenter(language='python')
+commenter.record_and_insert('main.py', line_number=15)
+
+# Transcribe only
+text = commenter.transcribe_only()
+print(text)  # "This function calculates factorial recursively"
+
+# Insert into code string (no file I/O)
+code = """
+def factorial(n):
+    return n * factorial(n - 1) if n > 1 else 1
+"""
+updated = commenter.insert_comment_to_string(
+    code,
+    "Base case for recursion",
+    line_number=3
+)
+print(updated)
+```
+
+### Jupyter Notebook
+
+```python
+from voicecomment import VoiceCommenter
+
+commenter = VoiceCommenter(language='python')
+
+# Record and modify cell code
+code_str = """
+def process_data(df):
+    return df.dropna()
+"""
+
+updated = commenter.insert_comment_to_string(
+    code_str,
+    "Remove rows with missing values",
+    line_number=2
+)
+print(updated)
+```
+
+## Architecture
+
+### Core Components
+
+#### 1. **AudioRecorder** (`recorder.py`)
+- `LocalAudioRecorder`: Captures audio from system microphone
+- Supports fixed duration or silence detection
+- Configurable sample rate, channels, and format
+
+#### 2. **Transcriber** (`transcriber.py`)
+Pluggable backends:
+- `WhisperTranscriber`: Local OpenAI Whisper model (no API key needed)
+- `OpenAITranscriber`: OpenAI Whisper API
+- `MockTranscriber`: For testing without audio hardware
+
+```python
+# Use local Whisper
+from voicecomment.transcriber import WhisperTranscriber
+transcriber = WhisperTranscriber(model_size="base")
+
+# Or OpenAI API
+from voicecomment.transcriber import OpenAITranscriber
+transcriber = OpenAITranscriber(api_key="sk-...")
+```
+
+#### 3. **CodeParser** (`parser.py`)
+Language-specific parsers:
+- `PythonParser`: Uses `#` prefix with proper indentation
+- `JavaScriptParser`: Uses `//` prefix
+- `GenericParser`: Configurable fallback for unsupported languages
+
+#### 4. **VoiceCommenter** (`commenter.py`)
+Main orchestration class that ties everything together.
+
+## Advanced Usage
+
+### Custom Transcriber
+
+```python
+from voicecomment import VoiceCommenter
+from voicecomment.transcriber import TranscriberBase
+import numpy as np
+
+class CustomLLMTranscriber(TranscriberBase):
+    def transcribe(self, audio: np.ndarray, sample_rate: int = 16000) -> str:
+        # Your LLM logic here
+        return "custom transcription"
+
+commenter = VoiceCommenter(transcriber=CustomLLMTranscriber())
+commenter.record_and_insert('file.py', line_number=10)
+```
+
+### Custom Audio Config
+
+```python
+from voicecomment import VoiceCommenter, AudioConfig
+
+config = AudioConfig(
+    sample_rate=44100,  # High-quality audio
+    channels=2,         # Stereo
+)
+
+commenter = VoiceCommenter(audio_config=config)
+```
+
+### Integration with IDE Extensions
+
+The Python package can be called from:
+- **VS Code Extension**: Via subprocess or Node.js child process
+- **Vim Plugin**: Via Python 3 interface
+- **Neovim**: Via Python plugin host
+- **Emacs**: Via `python-shell`
+
+Example VS Code extension (snippet):
+```typescript
+const { spawn } = require('child_process');
+
+const proc = spawn('voicecomment', ['record', filepath, lineNumber.toString()]);
+proc.on('close', (code) => {
+  if (code === 0) {
+    vscode.window.showInformationMessage('Comment inserted!');
+  }
+});
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/yourusername/voicecomment
+cd voicecomment
+pip install -e ".[dev]"
+```
+
+### Testing
+
+```bash
+pytest
+pytest --cov  # With coverage
+```
+
+### Code Quality
+
+```bash
+black .
+ruff check .
+mypy voicecomment/
+```
+
+## Supported Languages
+
+| Language | Extension | Comment Prefix |
+|----------|-----------|----------------|
+| Python | `.py`, `.pyw` | `#` |
+| JavaScript | `.js`, `.jsx`, `.mjs` | `//` |
+| TypeScript | `.ts`, `.tsx`, `.mts` | `//` |
+| Go | `.go` | `//` |
+| Rust | `.rs` | `//` |
+| Java | `.java` | `//` |
+| C# | `.cs` | `//` |
+| Ruby | `.rb` | `#` |
+| C/C++ | `.c`, `.cpp`, `.h`, `.hpp` | `//` |
+
+## Roadmap
+
+- [ ] VS Code Extension (official)
+- [ ] Vim/Neovim plugin
+- [ ] Watch mode for automated comment markers
+- [ ] Voice activity detection (VAD)
+- [ ] Conversation-aware transcription (context from file)
+- [ ] Custom prompt engineering for comment style
+- [ ] Analytics dashboard (tracking comment patterns)
+- [ ] LangChain integration for LLM-powered comments
+
+## Contributing
+
+Contributions welcome! Please open an issue or pull request.
+
+## License
+
+MIT License - see [LICENSE](LICENSE)
+
+---
+
+**Built for developers who believe code comments should be as natural as talking.**

speakline-0.1.0/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "speakline"
+version = "0.1.0"
+description = "Record voice and insert as inline code comments across any language and IDE"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.9"
+authors = [
+    {name = "VoiceComment Team"}
+]
+keywords = ["voice", "comments", "code", "transcription", "whisper", "developer-tools"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Multimedia :: Sound/Audio :: Speech",
+]
+
+dependencies = [
+    "pyaudio>=0.2.13",
+    "numpy>=1.24.0",
+    "openai-whisper>=20231117",
+    "openai>=1.0.0",
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+]
+
+[project.scripts]
+speakline = "voicecomment.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/likthvishal/SpeakLine"
+Repository = "https://github.com/likthvishal/SpeakLine"
+Issues = "https://github.com/likthvishal/SpeakLine/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["voicecomment*"]
+
+[tool.black]
+line-length = 100
+target-version = ["py39", "py310", "py311", "py312"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "C4"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+addopts = "-v"

speakline-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+