Metadata-Version: 2.4
Name: jupyter-voicecell
Version: 0.1.0
Summary: Voice comments for Jupyter notebook cells.
Project-URL: Homepage, https://github.com/Yahya-Kamran/voicecell
Project-URL: Bug Tracker, https://github.com/Yahya-Kamran/voicecell/issues
Project-URL: Repository, https://github.com/Yahya-Kamran/voicecell.git
Author-email: Muhammad Yahya Kamran <m.yahyakamran48@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Muhammad Yahya Kamran
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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:** BSD-3-Clause

## 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 — share notebook + folder and it works for anyone

## Installation

```bash
pip install 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

## Compatibility

- JupyterLab 4.x
- Jupyter Notebook 7.x
- Python 3.10+

## License

BSD-3-Clause © 2026 Muhammad Yahya Kamran