| Name | jupyterlab-pdf-preview JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | JupyterLab extension to preview PDF files in the file browser on hover. |
| upload_time | 2024-08-29 20:15:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JupyterLab PDF Preview
[](https://pypi.org/project/jupyterlab-pdf-preview/)
[](https://pypi.org/project/jupyterlab-pdf-preview/)
[](https://github.com/PainterQubits/jupyterlab-pdf-preview/blob/main/LICENSE)
[](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.
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-pdf-preview",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5a/e3/dd94afc7bb06eabc5abb7dcde0ce938868506c2719f2e84986500645b705/jupyterlab_pdf_preview-0.2.1.tar.gz",
"platform": null,
"description": "# JupyterLab PDF Preview\n\n[](https://pypi.org/project/jupyterlab-pdf-preview/)\n[](https://pypi.org/project/jupyterlab-pdf-preview/)\n[](https://github.com/PainterQubits/jupyterlab-pdf-preview/blob/main/LICENSE)\n[](https://github.com/PainterQubits/jupyterlab-pdf-preview/actions/workflows/ci.yml)\n\nJupyterLab extension to preview PDF files in the file browser on hover.\n\n## Installation\n\nInstall the latest version of JupyterLab PDF Preview using pip:\n\n```\npip install -U jupyterlab-pdf-preview\n```\n\nThis extension should run alongside\n[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)\nversion 4.\n\n## Development\n\nTo develop, the following dependencies must be installed:\n\n- [Python](https://www.python.org/downloads/)\n- [Hatch](https://hatch.pypa.io/latest/install/)\n- [Node.js](https://nodejs.org/en/download)\n\nTo build the extension and start up a JupyterLab server for development, run:\n\n```bash\nhatch run dev\n```\n\nWhen the source code changes, the extension should be automatically rebuilt, and the\nupdated extension will be used when the page is reloaded.\n\n> [!NOTE] \n> On Windows, symbolic links must be activated for `hatch run dev` to work. On Windows 10\n> or above, this can be done by\n> [activating developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).\n>\n> Alternatively, you can run\n>\n> ```bash\n> hatch run clean\n> hatch env remove default\n> hatch run jupyter lab\n> ```\n>\n> to completely reinstall the extension and start JupyterLab each time the source code\n> changes.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023\u20132024, 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.",
"summary": "JupyterLab extension to preview PDF files in the file browser on hover.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/PainterQubits/jupyterlab-pdf-preview",
"Repository": "https://github.com/PainterQubits/jupyterlab-pdf-preview"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d8d0b1e73b74e855b5d91b9513045c650c7b6058033cb715eeeac146371ea01",
"md5": "16dc74f029d4858b967fe773c6fb58b7",
"sha256": "d4000c8d4d30044a4094eb49ac313dc761ccc85ef094a3e1c29db1c3671b65e3"
},
"downloads": -1,
"filename": "jupyterlab_pdf_preview-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "16dc74f029d4858b967fe773c6fb58b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 509611,
"upload_time": "2024-08-29T20:15:17",
"upload_time_iso_8601": "2024-08-29T20:15:17.509769Z",
"url": "https://files.pythonhosted.org/packages/5d/8d/0b1e73b74e855b5d91b9513045c650c7b6058033cb715eeeac146371ea01/jupyterlab_pdf_preview-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ae3dd94afc7bb06eabc5abb7dcde0ce938868506c2719f2e84986500645b705",
"md5": "1a0fb1e7a3101fe8394308a8fbf268ca",
"sha256": "a65ea4a8b9ed98ce30810b48183a7d4659af54c1c039b931b6513bde80be391d"
},
"downloads": -1,
"filename": "jupyterlab_pdf_preview-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "1a0fb1e7a3101fe8394308a8fbf268ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 585973,
"upload_time": "2024-08-29T20:15:18",
"upload_time_iso_8601": "2024-08-29T20:15:18.956064Z",
"url": "https://files.pythonhosted.org/packages/5a/e3/dd94afc7bb06eabc5abb7dcde0ce938868506c2719f2e84986500645b705/jupyterlab_pdf_preview-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 20:15:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PainterQubits",
"github_project": "jupyterlab-pdf-preview",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-pdf-preview"
}
