| Name | rsp-jupyter-extensions JSON |
| Version |
0.13.0
JSON |
| download |
| home_page | None |
| Summary | Jupyter Extensions for the Rubin Science Platform |
| upload_time | 2024-10-19 00:07:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 LSST SQuaRE Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# rsp_jupyter_extensions
[](https://github.com/lsst-sqre/rsp-jupyter-extensions /actions/workflows/build.yml)
Jupyter Extensions for the Rubin Science Platform
This extension is composed of a Python package named `rsp_jupyter_extensions`
for the server extension and a NPM package named `rsp-jupyter-extensions`
for the frontend extension.
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install rsp_jupyter_extensions
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall rsp_jupyter_extensions
```
## 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 rsp_jupyter_extensions 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 rsp_jupyter_extensions
# 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 rsp_jupyter_extensions
pip uninstall rsp_jupyter_extensions
```
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 `rsp-jupyter-extensions` 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 rsp_jupyter_extensions
```
#### 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": "rsp-jupyter-extensions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Adam Thornton <athornton@lsst.org>",
"download_url": "https://files.pythonhosted.org/packages/47/7e/2d784764ff7f42419d2dea9eea6c3510be6bdd7f3e4690bc81e94229abe2/rsp_jupyter_extensions-0.13.0.tar.gz",
"platform": null,
"description": "# rsp_jupyter_extensions\n\n[](https://github.com/lsst-sqre/rsp-jupyter-extensions /actions/workflows/build.yml)\nJupyter Extensions for the Rubin Science Platform\n\nThis extension is composed of a Python package named `rsp_jupyter_extensions`\nfor the server extension and a NPM package named `rsp-jupyter-extensions`\nfor the frontend extension.\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install rsp_jupyter_extensions\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall rsp_jupyter_extensions\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 rsp_jupyter_extensions 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 rsp_jupyter_extensions\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 rsp_jupyter_extensions\npip uninstall rsp_jupyter_extensions\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 `rsp-jupyter-extensions` 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 rsp_jupyter_extensions\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": "MIT License Copyright (c) 2023 LSST SQuaRE Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Jupyter Extensions for the Rubin Science Platform",
"version": "0.13.0",
"project_urls": {
"Bug Tracker": "https://github.com/lsst-sqre/rsp-jupyter-extensions /issues",
"Homepage": "https://github.com/lsst-sqre/rsp-jupyter-extensions",
"Repository": "https://github.com/lsst-sqre/rsp-jupyter-extensions .git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bdd0ad5e924f795537aee17c63a703d168eaee9e80eb0c0afaa37f0d4175de1",
"md5": "fdbbcd9ea89fe20da1488c459ab3042a",
"sha256": "89fad98cc3ba152d93e534a0464eba34368deac848361d3e410487bb985d828e"
},
"downloads": -1,
"filename": "rsp_jupyter_extensions-0.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fdbbcd9ea89fe20da1488c459ab3042a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27236,
"upload_time": "2024-10-19T00:07:16",
"upload_time_iso_8601": "2024-10-19T00:07:16.591682Z",
"url": "https://files.pythonhosted.org/packages/3b/dd/0ad5e924f795537aee17c63a703d168eaee9e80eb0c0afaa37f0d4175de1/rsp_jupyter_extensions-0.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "477e2d784764ff7f42419d2dea9eea6c3510be6bdd7f3e4690bc81e94229abe2",
"md5": "75eec365d41fa222c4aa6321dc4731b4",
"sha256": "186763c7149cd008571dc6d4dc8b99acde34a3e0bec7535c6908c96efb3015c6"
},
"downloads": -1,
"filename": "rsp_jupyter_extensions-0.13.0.tar.gz",
"has_sig": false,
"md5_digest": "75eec365d41fa222c4aa6321dc4731b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 151004,
"upload_time": "2024-10-19T00:07:18",
"upload_time_iso_8601": "2024-10-19T00:07:18.375050Z",
"url": "https://files.pythonhosted.org/packages/47/7e/2d784764ff7f42419d2dea9eea6c3510be6bdd7f3e4690bc81e94229abe2/rsp_jupyter_extensions-0.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 00:07:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lsst-sqre",
"github_project": "rsp-jupyter-extensions ",
"github_not_found": true,
"lcname": "rsp-jupyter-extensions"
}
