| Name | jupyterlab-doc-reader-extension JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | Jupyterlab extension that allows reading of the docx documents |
| upload_time | 2025-10-26 17:11:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License
Copyright (c) 2025, Stellars Henson
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. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# JupyterLab Document Reader Extension
[](https://www.npmjs.com/package/jupyterlab_doc_reader_extension)
[](https://pypi.org/project/jupyterlab-doc-reader-extension/)
A JupyterLab extension that allows viewing Microsoft Word documents (DOCX, DOC) and Rich Text Format (RTF) files directly in JupyterLab. The extension automatically converts documents to PDF on-the-fly for seamless viewing without creating persistent files.
## Features
- View DOCX, DOC, and RTF files directly in JupyterLab
- Automatic conversion to PDF for display (no temporary files created in your workspace)
- Native PDF rendering in the browser
- Unicode support with automatic font detection for international characters (Polish, German, French, etc.)
- Read-only mode to prevent accidental modifications
- Clean, integrated interface matching JupyterLab's design
## Architecture
This extension consists of:
- **Python server extension**: Handles document-to-PDF conversion using pure Python libraries (python-docx + reportlab)
- **TypeScript frontend extension**: Provides the document viewer widget and file type registration
## Requirements
- JupyterLab >= 4.0.0
- Python >= 3.9
- No external system dependencies required (pure Python solution)
## Install
Simply install the extension with pip:
```bash
pip install jupyterlab_doc_reader_extension
```
All required Python dependencies (python-docx, reportlab) will be installed automatically.
## Usage
Once installed, simply click on any `.docx`, `.doc`, or `.rtf` file in the JupyterLab file browser. The extension will automatically:
1. Convert the document to PDF on the server
2. Stream the PDF to your browser
3. Display it in a dedicated viewer tab
No temporary files are created in your workspace - the conversion happens in memory on the server side.
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterlab_doc_reader_extension
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab_doc_reader_extension directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_doc_reader_extension
# Rebuild extension Typescript source after making changes
jlpm build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_doc_reader_extension
pip uninstall jupyterlab_doc_reader_extension
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyterlab_doc_reader_extension` within that folder.
### Testing the extension
#### Server tests
This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
Install test dependencies (needed only once):
```sh
pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite
```
To execute them, run:
```sh
pytest -vv -r ap --cov jupyterlab_doc_reader_extension
```
#### Frontend tests
This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
To execute them, execute:
```sh
jlpm
jlpm test
```
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-doc-reader-extension",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Stellars Henson <konrad.jelen@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/15/01/f4bd804d2adf03f35c6caea4a1ae87022976778ba51cf203ba57770ff97f/jupyterlab_doc_reader_extension-1.0.4.tar.gz",
"platform": null,
"description": "# JupyterLab Document Reader Extension\n\n\n[](https://www.npmjs.com/package/jupyterlab_doc_reader_extension)\n[](https://pypi.org/project/jupyterlab-doc-reader-extension/)\n\n\nA JupyterLab extension that allows viewing Microsoft Word documents (DOCX, DOC) and Rich Text Format (RTF) files directly in JupyterLab. The extension automatically converts documents to PDF on-the-fly for seamless viewing without creating persistent files.\n\n\n\n\n## Features\n\n- View DOCX, DOC, and RTF files directly in JupyterLab\n- Automatic conversion to PDF for display (no temporary files created in your workspace)\n- Native PDF rendering in the browser\n- Unicode support with automatic font detection for international characters (Polish, German, French, etc.)\n- Read-only mode to prevent accidental modifications\n- Clean, integrated interface matching JupyterLab's design\n\n## Architecture\n\nThis extension consists of:\n- **Python server extension**: Handles document-to-PDF conversion using pure Python libraries (python-docx + reportlab)\n- **TypeScript frontend extension**: Provides the document viewer widget and file type registration\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n- Python >= 3.9\n- No external system dependencies required (pure Python solution)\n\n## Install\n\nSimply install the extension with pip:\n\n```bash\npip install jupyterlab_doc_reader_extension\n```\n\nAll required Python dependencies (python-docx, reportlab) will be installed automatically.\n\n## Usage\n\nOnce installed, simply click on any `.docx`, `.doc`, or `.rtf` file in the JupyterLab file browser. The extension will automatically:\n1. Convert the document to PDF on the server\n2. Stream the PDF to your browser\n3. Display it in a dedicated viewer tab\n\nNo temporary files are created in your workspace - the conversion happens in memory on the server side.\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab_doc_reader_extension\n```\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyterlab_doc_reader_extension directory\n# Install package in development mode\npip install -e \".[test]\"\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable jupyterlab_doc_reader_extension\n# Rebuild extension Typescript source after making changes\njlpm build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\nBy default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable jupyterlab_doc_reader_extension\npip uninstall jupyterlab_doc_reader_extension\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupyterlab_doc_reader_extension` within that folder.\n\n### Testing the extension\n\n#### Server tests\n\nThis extension is using [Pytest](https://docs.pytest.org/) for Python code testing.\n\nInstall test dependencies (needed only once):\n\n```sh\npip install -e \".[test]\"\n# Each time you install the Python package, you need to restore the front-end extension link\njupyter labextension develop . --overwrite\n```\n\nTo execute them, run:\n\n```sh\npytest -vv -r ap --cov jupyterlab_doc_reader_extension\n```\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, Stellars Henson\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Jupyterlab extension that allows reading of the docx documents",
"version": "1.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/stellarshenson/jupyterlab_doc_reader_extension/issues",
"Homepage": "https://github.com/stellarshenson/jupyterlab_doc_reader_extension.git",
"Repository": "https://github.com/stellarshenson/jupyterlab_doc_reader_extension.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "47555663f421537520728966fa836cdeda2a3bcc8d37979b973592cff423ed22",
"md5": "e008879402bafdc472cd7f95b58ac289",
"sha256": "05ec885d877ec0e3830c4aaea126f15cbad24a0441128d26c6125157caad261a"
},
"downloads": -1,
"filename": "jupyterlab_doc_reader_extension-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e008879402bafdc472cd7f95b58ac289",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 24714,
"upload_time": "2025-10-26T17:11:38",
"upload_time_iso_8601": "2025-10-26T17:11:38.951698Z",
"url": "https://files.pythonhosted.org/packages/47/55/5663f421537520728966fa836cdeda2a3bcc8d37979b973592cff423ed22/jupyterlab_doc_reader_extension-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1501f4bd804d2adf03f35c6caea4a1ae87022976778ba51cf203ba57770ff97f",
"md5": "8c667dc1298ba4c5184af11fe209c856",
"sha256": "f422b5468f0861d207e8c129daa7f577ad6820433b40a96b408de82d6aa28346"
},
"downloads": -1,
"filename": "jupyterlab_doc_reader_extension-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "8c667dc1298ba4c5184af11fe209c856",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 537196,
"upload_time": "2025-10-26T17:11:40",
"upload_time_iso_8601": "2025-10-26T17:11:40.442299Z",
"url": "https://files.pythonhosted.org/packages/15/01/f4bd804d2adf03f35c6caea4a1ae87022976778ba51cf203ba57770ff97f/jupyterlab_doc_reader_extension-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-26 17:11:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stellarshenson",
"github_project": "jupyterlab_doc_reader_extension",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-doc-reader-extension"
}
