Metadata-Version: 2.4
Name: jupyter-voicecell
Version: 0.1.1
Summary: Voice comments for Jupyter notebook cells.
Project-URL: Homepage, https://github.com/Yahya-Kamran/jupyter-voicecell
Project-URL: Bug Tracker, https://github.com/Yahya-Kamran/jupyter-voicecell/issues
Project-URL: Repository, https://github.com/Yahya-Kamran/jupyter-voicecell.git
Author-email: Muhammad Yahya Kamran <m.yahyakamran48@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Muhammad Yahya Kamran
        
        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.
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: jupyter-builder>=1.0.0; extra == 'dev'
Requires-Dist: jupyterlab>=4; extra == 'dev'
Description-Content-Type: text/markdown

# VoiceCell 🎙

> Voice notes for Jupyter notebooks — record audio comments linked to specific lines of code.

**Author:** Muhammad Yahya Kamran  
**License:** MIT

## What it does

VoiceCell adds a **Voice Note** button to your JupyterLab toolbar. Click on any line of code, press the button (or `Alt+V`), and record a voice note. The recording is saved next to your notebook and a clickable 🔊 marker is injected into that exact line.

## Features

- 🎙 Record voice notes linked to specific cells and lines
- 🔊 Click the speaker icon to play back inline
- 🌊 Waveform visualization
- ⏩ Playback speed control (0.5x, 1x, 1.5x, 2x)
- 🗑 Delete voice notes from within the player
- 💾 Audio saved to `voicecells_of_(notebook)` folder alongside your notebook
- 📓 References stored in notebook metadata

## Installation

```bash
pip install jupyter-voicecell
```

Requires JupyterLab 4. After installing, restart JupyterLab.

## Usage

1. Open any notebook in JupyterLab
2. Click inside a cell on the line you want to annotate
3. Click **Voice Note** in the toolbar or press `Alt+V`
4. Record your message and click **Stop & Save**
5. A `# 🔊 vm_1 [timestamp]` comment appears on that line
6. Click the 🔊 to play it back anytime

## Sharing notebooks

Share the `.ipynb` file together with the `voicecells_of_<notebookname>` folder. Anyone with VoiceCell installed can play back all voice notes.

## Privacy & Safety

- 🔒 Microphone access is local only — browser permission required
- 💾 Audio saved locally as `.webm` files — never uploaded anywhere
- 🚫 No telemetry, no tracking, no external connections
- 📓 Metadata stored inside the notebook file itself

## Compatibility

- JupyterLab 4.x ✅
- Jupyter Notebook 7.x ✅
- PyCharm Jupyter notebooks — planned
- VS Code Jupyter notebooks — planned (requires separate VS Code extension)

## License

MIT © 2026 Muhammad Yahya Kamran