Metadata-Version: 2.4
Name: jupyterlab_pomodoro
Version: 0.1.0
Dynamic: Keywords
Summary: A JupyterLab extension for Pomodoro timer
Project-URL: Homepage, https://github.com/MakinetaJim/jupyterlab-pomodoro
Project-URL: Bug Tracker, https://github.com/MakinetaJim/jupyterlab-pomodoro/issues
Project-URL: Repository, https://github.com/MakinetaJim/jupyterlab-pomodoro.git
Author-email: Your Name <your@email.com>
License: BSD 3-Clause License
        
        Copyright (c) 2026, Your Name
        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
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 :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-check-links; extra == 'test'
Requires-Dist: pytest-jupyter; extra == 'test'
Requires-Dist: pytest-tornasync; extra == 'test'
Requires-Dist: requests; extra == 'test'
Description-Content-Type: text/markdown

# jupyterlab-pomodoro

A JupyterLab extension for Pomodoro timer productivity tracking.

## Features

- 🍅 **Pomodoro timer** in the JupyterLab status bar
- ▶️ **Start / ⏸ Pause** the timer with one click
- ↺ **Reset** the current session
- Automatic **work → short break → long break** cycling
- 🔔 **Desktop notifications** when a phase ends
- ⚙️ **Configurable** durations via JupyterLab Settings Editor

## Requirements

- JupyterLab >= 4.0.0

## Install

```bash
pip install jupyterlab_pomodoro
```

## Development Install

```bash
# Clone the repo and activate a venv with JupyterLab installed
git clone https://github.com/MakinetaJim/jupyterlab-pomodoro
cd jupyterlab-pomodoro

# Install JS deps and build
jlpm install
jlpm build

# Install extension in dev mode
pip install -e ".[test]"
jupyter labextension develop . --overwrite

# Watch for changes
jlpm watch
```

## Settings

Open **Settings → Settings Editor → Pomodoro Timer** to configure:

| Setting | Default | Description |
|---|---|---|
| Work Duration | 25 min | Length of a work session |
| Short Break | 5 min | Short break after each pomodoro |
| Long Break | 15 min | Long break after N pomodoros |
| Long Break Interval | 4 | Pomodoros before a long break |

## License

BSD 3-Clause
