Name | jupyterlab-spreadsheet-editor JSON |
Version |
0.7.1
JSON |
| download |
home_page | |
Summary | JupyterLab spreadsheet (csv/tsv) editor |
upload_time | 2024-03-16 19:59:15 |
maintainer | |
docs_url | None |
author | Michał Krassowski |
requires_python | >=3.8 |
license | BSD 3-Clause License Copyright (c) 2020, Michał Krassowski All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * 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 |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# JupyterLab Spreadsheet Editor
[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)
[![GitHub Action Status](https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/actions/workflows/build.yml/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/actions/workflows/build.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main?urlpath=lab)
[![pypi-version](https://img.shields.io/pypi/v/jupyterlab-spreadsheet-editor.svg)](https://python.org/pypi/jupyterlab-spreadsheet-editor)
JupyterLab spreadsheet editor enables interactive editing of comma/tab separated value spreadsheets.
It support formulas, sorting, column/row rearrangements and more!
> Note: you might be interested to checkout [tabular-data-editor](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor) as well
## Showcase
**Fully featured integration**
- row/column operations, column width adjustment
- search and replace
![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/setosa-demo.gif)
**Formula support**
basic formula calculation (rendering) - as implemented by jExcel.
![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/formula-support.gif)
**Column freezing**
for exploration of wide datasets with many covariates
![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/freeze-support.gif)
**Launcher items**:
create CSV/TSV files easily from the launcher or the palette.
![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/launcher.png)
**Lightweight and reliable dependencies**:
the spreadsheet interface is built with the [jexcel](https://github.com/paulhodel/jexcel), while [Papa Parse](https://github.com/mholt/PapaParse) provides very fast, [RFC 4180](https://tools.ietf.org/html/rfc4180) compatible CSV parsing (both have no third-party dependencies).
## Requirements
- JupyterLab >= 3.0
## Install
```bash
pip install jupyterlab-spreadsheet-editor
```
## 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-spreadsheet-editor directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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 run 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
```
### Uninstall
```bash
pip uninstall jupyterlab-spreadsheet-editor
```
## Related extensions
Spreadsheet editors:
- [jupyterlab-tabular-data-editor](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor)
Spreadsheet viewers:
- [jupyterlab-spreadsheet](https://github.com/quigleyj97/jupyterlab-spreadsheet) implements Excel spreadsheet viewer
- the built-in [csvviewer](https://github.com/jupyterlab/jupyterlab/tree/master/packages/csvviewer) ([extension](https://github.com/jupyterlab/jupyterlab/tree/master/packages/csvviewer-extension)) allows to display CSV/TSV files
In-notebook spreadsheet widgets:
- [ipysheet](https://github.com/QuantStack/ipysheet) - programmable sheet creation, exploration and modification
- [qgrid](https://github.com/quantopian/qgrid) - interactive DataFrame exploration and modification
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlab-spreadsheet-editor",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Micha\u0142 Krassowski",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e4/d2/61103f00a4d6e2f11430ad8084783b37e1ba3c2e56c8f25f8ca0eb8a434b/jupyterlab_spreadsheet_editor-0.7.1.tar.gz",
"platform": null,
"description": "# JupyterLab Spreadsheet Editor\n\n[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)\n[![GitHub Action Status](https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/actions/workflows/build.yml/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/actions/workflows/build.yml)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main?urlpath=lab)\n[![pypi-version](https://img.shields.io/pypi/v/jupyterlab-spreadsheet-editor.svg)](https://python.org/pypi/jupyterlab-spreadsheet-editor)\n\nJupyterLab spreadsheet editor enables interactive editing of comma/tab separated value spreadsheets.\nIt support formulas, sorting, column/row rearrangements and more!\n\n> Note: you might be interested to checkout [tabular-data-editor](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor) as well\n\n## Showcase\n\n**Fully featured integration**\n\n- row/column operations, column width adjustment\n- search and replace\n\n![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/setosa-demo.gif)\n\n**Formula support**\nbasic formula calculation (rendering) - as implemented by jExcel.\n\n![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/formula-support.gif)\n\n**Column freezing**\nfor exploration of wide datasets with many covariates\n\n![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/freeze-support.gif)\n\n**Launcher items**:\ncreate CSV/TSV files easily from the launcher or the palette.\n\n![](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/main/screenshots/launcher.png)\n\n**Lightweight and reliable dependencies**:\nthe spreadsheet interface is built with the [jexcel](https://github.com/paulhodel/jexcel), while [Papa Parse](https://github.com/mholt/PapaParse) provides very fast, [RFC 4180](https://tools.ietf.org/html/rfc4180) compatible CSV parsing (both have no third-party dependencies).\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Install\n\n```bash\npip install jupyterlab-spreadsheet-editor\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-spreadsheet-editor directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm run 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 run 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 run 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### Uninstall\n\n```bash\npip uninstall jupyterlab-spreadsheet-editor\n```\n\n## Related extensions\n\nSpreadsheet editors:\n\n- [jupyterlab-tabular-data-editor](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor)\n\nSpreadsheet viewers:\n\n- [jupyterlab-spreadsheet](https://github.com/quigleyj97/jupyterlab-spreadsheet) implements Excel spreadsheet viewer\n- the built-in [csvviewer](https://github.com/jupyterlab/jupyterlab/tree/master/packages/csvviewer) ([extension](https://github.com/jupyterlab/jupyterlab/tree/master/packages/csvviewer-extension)) allows to display CSV/TSV files\n\nIn-notebook spreadsheet widgets:\n\n- [ipysheet](https://github.com/QuantStack/ipysheet) - programmable sheet creation, exploration and modification\n- [qgrid](https://github.com/quantopian/qgrid) - interactive DataFrame exploration and modification\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2020, Micha\u0142 Krassowski All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * 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 spreadsheet (csv/tsv) editor",
"version": "0.7.1",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor/issues",
"Homepage": "https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor",
"Repository": "https://github.com/jupyterlab-contrib/jupyterlab-spreadsheet-editor.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af5140554bda66ae89ecdcbc68c9a875d060fbdbdf3ae66646d92444621143a6",
"md5": "c09eaa771731d560edb2673d78c69be9",
"sha256": "a83dddd4c08244834decaa37182b9f0b7f48972322afc0d6ef897ee212a6ee36"
},
"downloads": -1,
"filename": "jupyterlab_spreadsheet_editor-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c09eaa771731d560edb2673d78c69be9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 164972,
"upload_time": "2024-03-16T19:59:11",
"upload_time_iso_8601": "2024-03-16T19:59:11.123270Z",
"url": "https://files.pythonhosted.org/packages/af/51/40554bda66ae89ecdcbc68c9a875d060fbdbdf3ae66646d92444621143a6/jupyterlab_spreadsheet_editor-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e4d261103f00a4d6e2f11430ad8084783b37e1ba3c2e56c8f25f8ca0eb8a434b",
"md5": "83a9fb5b4fb7253fbaad116aa28759d3",
"sha256": "71b4e18dac80873f1a36ad880abb5cb2f09d957b233fafc66cdaefdeef075207"
},
"downloads": -1,
"filename": "jupyterlab_spreadsheet_editor-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "83a9fb5b4fb7253fbaad116aa28759d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1857689,
"upload_time": "2024-03-16T19:59:15",
"upload_time_iso_8601": "2024-03-16T19:59:15.455018Z",
"url": "https://files.pythonhosted.org/packages/e4/d2/61103f00a4d6e2f11430ad8084783b37e1ba3c2e56c8f25f8ca0eb8a434b/jupyterlab_spreadsheet_editor-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 19:59:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlab-contrib",
"github_project": "jupyterlab-spreadsheet-editor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-spreadsheet-editor"
}