Metadata-Version: 2.3
Name: jupyterlab-pdf-preview
Version: 0.2.1
Dynamic: Author
Dynamic: Author-email
Summary: JupyterLab extension to preview PDF files in the file browser on hover.
Project-URL: Homepage, https://github.com/PainterQubits/jupyterlab-pdf-preview
Project-URL: Repository, https://github.com/PainterQubits/jupyterlab-pdf-preview
License: BSD 3-Clause License
        
        Copyright (c) 2023–2024, California Institute of Technology
        
        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 :: BSD License
Classifier: Programming Language :: Python
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
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# JupyterLab PDF Preview

[![PyPI Latest Release](https://img.shields.io/pypi/v/jupyterlab-pdf-preview)](https://pypi.org/project/jupyterlab-pdf-preview/)
[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/jupyterlab-pdf-preview)](https://pypi.org/project/jupyterlab-pdf-preview/)
[![License](https://img.shields.io/pypi/l/jupyterlab-pdf-preview)](https://github.com/PainterQubits/jupyterlab-pdf-preview/blob/main/LICENSE)
[![CI](https://github.com/PainterQubits/jupyterlab-pdf-preview/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/jupyterlab-pdf-preview/actions/workflows/ci.yml)

JupyterLab extension to preview PDF files in the file browser on hover.

## Installation

Install the latest version of JupyterLab PDF Preview using pip:

```
pip install -U jupyterlab-pdf-preview
```

This extension should run alongside
[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)
version 4.

## Development

To develop, the following dependencies must be installed:

- [Python](https://www.python.org/downloads/)
- [Hatch](https://hatch.pypa.io/latest/install/)
- [Node.js](https://nodejs.org/en/download)

To build the extension and start up a JupyterLab server for development, run:

```bash
hatch run dev
```

When the source code changes, the extension should be automatically rebuilt, and the
updated extension will be used when the page is reloaded.

> [!NOTE]  
> On Windows, symbolic links must be activated for `hatch run dev` to work. On Windows 10
> or above, this can be done by
> [activating developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).
>
> Alternatively, you can run
>
> ```bash
> hatch run clean
> hatch env remove default
> hatch run jupyter lab
> ```
>
> to completely reinstall the extension and start JupyterLab each time the source code
> changes.
