| Name | jupyterlab-skip-traceback JSON |
| Version |
5.1.0
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension for rendering Errors with a copy/paste button and expand/collapse |
| upload_time | 2024-04-01 01:07:46 |
| maintainer | None |
| docs_url | None |
| author | Marc Udoff |
| requires_python | >=3.8 |
| license | Copyright 2020 D. E. Shaw & Co., L.P. 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlab-skip-traceback
[![PyPI version][pypi-image]][pypi-url] [![PyPI DM][pypi-dm-image]][pypi-url]
[![Github Actions Status][github-status-image]][github-status-url] [![Binder][binder-image]][binder-url]
A JupyterLab extension for rendering Errors with a copy/paste button and expand/collapse.
This is inspired by the notebook version [here](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions/skip-traceback).
## Requirements
- JupyterLab >= 4.0
## Install
```bash
pip install jupyterlab-skip-traceback
```
## 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-skip-traceback 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
```
#### Publishing
Before starting, you'll need to have run: `pip install twine jupyter_packaging`
1. Update the version in `package.json` and update the release date in `CHANGELOG.md`
2. Commit the change in step 1, tag it, then push it
```
git commit -am <msg>
git tag vX.Z.Y
git push && git push --tags
```
3. Create the artifacts
```
rm -rf dist tsconfig.tsbuildinfo lib jupyterlab-skip-traceback/labextension jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl
hatch build .
```
4. Test this against the test pypi. You can then install from here to test as well:gi
```
twine upload --repository-url https://test.pypi.org/legacy/ jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_skip_traceback
```
5. Upload this to pypi:
```
twine upload jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl
```
### Uninstall
```bash
pip uninstall jupyterlab-skip-traceback
```
## History
This plugin was contributed back to the community by the [D. E. Shaw group](https://www.deshaw.com/).
<p align="center">
<a href="https://www.deshaw.com">
<img src="https://www.deshaw.com/assets/logos/blue_logo_417x125.png" alt="D. E. Shaw Logo" height="75" >
</a>
</p>
## License
This project is released under a [BSD-3-Clause license](https://github.com/deshaw/jupyterlab-skip-traceback/blob/master/LICENSE.txt).
We love contributions! Before you can contribute, please sign and submit this [Contributor License Agreement (CLA)](https://www.deshaw.com/oss/cla).
This CLA is in place to protect all users of this project.
"Jupyter" is a trademark of the NumFOCUS foundation, of which Project Jupyter is a part.
[pypi-url]: https://pypi.org/project/jupyterlab-skip-traceback
[pypi-image]: https://img.shields.io/pypi/v/jupyterlab-skip-traceback
[pypi-dm-image]: https://img.shields.io/pypi/dm/jupyterlab-skip-traceback
[github-status-image]: https://github.com/deshaw/jupyterlab-skip-traceback/workflows/Build/badge.svg
[github-status-url]: https://github.com/deshaw/jupyterlab-skip-traceback/actions?query=workflow%3ABuild
[binder-image]: https://mybinder.org/badge_logo.svg
[binder-url]: https://mybinder.org/v2/gh/deshaw/jupyterlab-skip-traceback.git/master?urlpath=lab%2Ftree%2Fnotebooks%2Findex.ipynb
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-skip-traceback",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Marc Udoff",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f8/93/f5a4816470b417c7ee1f3c9d2f4b89989d7448a6a8db66f91916d459b023/jupyterlab_skip_traceback-5.1.0.tar.gz",
"platform": null,
"description": "# jupyterlab-skip-traceback\n\n[![PyPI version][pypi-image]][pypi-url] [![PyPI DM][pypi-dm-image]][pypi-url]\n[![Github Actions Status][github-status-image]][github-status-url] [![Binder][binder-image]][binder-url]\n\nA JupyterLab extension for rendering Errors with a copy/paste button and expand/collapse.\n\nThis is inspired by the notebook version [here](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/tree/master/src/jupyter_contrib_nbextensions/nbextensions/skip-traceback).\n\n\n\n## Requirements\n\n- JupyterLab >= 4.0\n\n## Install\n\n```bash\npip install jupyterlab-skip-traceback\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-skip-traceback 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#### Publishing\n\nBefore starting, you'll need to have run: `pip install twine jupyter_packaging`\n\n1. Update the version in `package.json` and update the release date in `CHANGELOG.md`\n2. Commit the change in step 1, tag it, then push it\n\n```\ngit commit -am <msg>\ngit tag vX.Z.Y\ngit push && git push --tags\n```\n\n3. Create the artifacts\n\n```\nrm -rf dist tsconfig.tsbuildinfo lib jupyterlab-skip-traceback/labextension jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl\nhatch build .\n```\n\n4. Test this against the test pypi. You can then install from here to test as well:gi\n\n```\ntwine upload --repository-url https://test.pypi.org/legacy/ jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl\n# In a new venv\npip install --index-url https://test.pypi.org/simple/ jupyterlab_skip_traceback\n```\n\n5. Upload this to pypi:\n\n```\ntwine upload jupyterlab_skip_traceback-*.tar.gz jupyterlab_skip_traceback-*.whl\n```\n\n### Uninstall\n\n```bash\npip uninstall jupyterlab-skip-traceback\n```\n\n## History\n\nThis plugin was contributed back to the community by the [D. E. Shaw group](https://www.deshaw.com/).\n\n<p align=\"center\">\n <a href=\"https://www.deshaw.com\">\n <img src=\"https://www.deshaw.com/assets/logos/blue_logo_417x125.png\" alt=\"D. E. Shaw Logo\" height=\"75\" >\n </a>\n</p>\n\n## License\n\nThis project is released under a [BSD-3-Clause license](https://github.com/deshaw/jupyterlab-skip-traceback/blob/master/LICENSE.txt).\n\nWe love contributions! Before you can contribute, please sign and submit this [Contributor License Agreement (CLA)](https://www.deshaw.com/oss/cla).\nThis CLA is in place to protect all users of this project.\n\n\"Jupyter\" is a trademark of the NumFOCUS foundation, of which Project Jupyter is a part.\n\n[pypi-url]: https://pypi.org/project/jupyterlab-skip-traceback\n[pypi-image]: https://img.shields.io/pypi/v/jupyterlab-skip-traceback\n[pypi-dm-image]: https://img.shields.io/pypi/dm/jupyterlab-skip-traceback\n[github-status-image]: https://github.com/deshaw/jupyterlab-skip-traceback/workflows/Build/badge.svg\n[github-status-url]: https://github.com/deshaw/jupyterlab-skip-traceback/actions?query=workflow%3ABuild\n[binder-image]: https://mybinder.org/badge_logo.svg\n[binder-url]: https://mybinder.org/v2/gh/deshaw/jupyterlab-skip-traceback.git/master?urlpath=lab%2Ftree%2Fnotebooks%2Findex.ipynb\n",
"bugtrack_url": null,
"license": "Copyright 2020 D. E. Shaw & Co., L.P. 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.",
"summary": "A JupyterLab extension for rendering Errors with a copy/paste button and expand/collapse",
"version": "5.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/deshaw/jupyterlab-skip-traceback/issues",
"Homepage": "https://github.com/deshaw/jupyterlab-skip-traceback",
"Repository": "https://github.com/deshaw/jupyterlab-skip-traceback.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09fdcd64e02eaeb2afd9c56bad6004c89bed73fee73b4379c320c9696d5b9161",
"md5": "271326930fbb1516c96c8e96b560a1e5",
"sha256": "e54f115ec65fab7f7affbd67f95e48e9ba07353cb3199008aa835227bccb7260"
},
"downloads": -1,
"filename": "jupyterlab_skip_traceback-5.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "271326930fbb1516c96c8e96b560a1e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 106619,
"upload_time": "2024-04-01T01:07:45",
"upload_time_iso_8601": "2024-04-01T01:07:45.327962Z",
"url": "https://files.pythonhosted.org/packages/09/fd/cd64e02eaeb2afd9c56bad6004c89bed73fee73b4379c320c9696d5b9161/jupyterlab_skip_traceback-5.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f893f5a4816470b417c7ee1f3c9d2f4b89989d7448a6a8db66f91916d459b023",
"md5": "bbf34cade494a4b6bb51c2899ea98b73",
"sha256": "c05086a74c085b0bc47598216c9044f94c2da02a36fb0f369ad0eb17915ef222"
},
"downloads": -1,
"filename": "jupyterlab_skip_traceback-5.1.0.tar.gz",
"has_sig": false,
"md5_digest": "bbf34cade494a4b6bb51c2899ea98b73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 239698,
"upload_time": "2024-04-01T01:07:46",
"upload_time_iso_8601": "2024-04-01T01:07:46.662052Z",
"url": "https://files.pythonhosted.org/packages/f8/93/f5a4816470b417c7ee1f3c9d2f4b89989d7448a6a8db66f91916d459b023/jupyterlab_skip_traceback-5.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 01:07:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deshaw",
"github_project": "jupyterlab-skip-traceback",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-skip-traceback"
}
