| Name | jupyterlab-ui-profiler JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | |
| Summary | JupyterLab extension for profiling UI performance |
| upload_time | 2023-05-01 22:05:05 |
| maintainer | |
| docs_url | None |
| author | Project Jupyter Contributors |
| requires_python | >=3.7 |
| license | BSD 3-Clause License Copyright (c) 2022, Project Jupyter Contributors 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-ui-profiler
[](https://github.com/jupyterlab/ui-profiler/actions/workflows/build.yml)
[](https://mybinder.org/v2/gh/jupyterlab/ui-profiler/main?urlpath=lab)
[](http://ui-profiler.readthedocs.io/en/latest/)
JupyterLab extension for profiling UI performance.
You can find more information in our [User Guide](https://ui-profiler.readthedocs.io/en/latest/user_guide.html).
Note: when this extension is enabled, the server will return additional headers:
- to allow high-precision `performance.now()` measurements in Firefox 79+:
```
Cross-Origin-Opener-Policy: same-origin,
Cross-Origin-Embedder-Policy: require-corp
```
- to enable JavaScript self-profiling in Chrome:
```
Document-Policy: js-profiling
```
If this is undesirable in your deployment, but you still want to use the profiler without these functions,
you can disable the server extension which sets these headers with:
```
jupyter server extension disable jupyterlab_ui_profiler
```
## Requirements
- JupyterLab >= 3.0
## Install
To install the extension, execute:
```bash
pip install jupyterlab-ui-profiler
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterlab-ui-profiler
```
## 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-ui-profiler 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 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
pip uninstall jupyterlab-ui-profiler
```
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/ui-profiler` within that folder.
### Testing the 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](https://github.com/jupyterlab/ui-profiler/main/ui-tests/README.md) README.
### Documentation
To build locally:
```
make -C docs/ html SPHINXOPTS="-W"
```
To build in watch mode:
```
sphinx-autobuild docs/source docs/build/html
```
### Packaging the extension
See [RELEASE](https://github.com/jupyterlab/ui-profiler/main/RELEASE.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlab-ui-profiler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Project Jupyter Contributors",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f6/ce/80c10ff035ed15e96f23e25377ac83260248ecac6a8f5c4a18a583125d95/jupyterlab_ui_profiler-0.2.2.tar.gz",
"platform": null,
"description": "# jupyterlab-ui-profiler\n\n[](https://github.com/jupyterlab/ui-profiler/actions/workflows/build.yml)\n[](https://mybinder.org/v2/gh/jupyterlab/ui-profiler/main?urlpath=lab)\n[](http://ui-profiler.readthedocs.io/en/latest/)\n\nJupyterLab extension for profiling UI performance.\n\n\n\nYou can find more information in our [User Guide](https://ui-profiler.readthedocs.io/en/latest/user_guide.html).\n\nNote: when this extension is enabled, the server will return additional headers:\n\n- to allow high-precision `performance.now()` measurements in Firefox 79+:\n\n ```\n Cross-Origin-Opener-Policy: same-origin,\n Cross-Origin-Embedder-Policy: require-corp\n ```\n\n- to enable JavaScript self-profiling in Chrome:\n ```\n Document-Policy: js-profiling\n ```\n\nIf this is undesirable in your deployment, but you still want to use the profiler without these functions,\nyou can disable the server extension which sets these headers with:\n\n```\njupyter server extension disable jupyterlab_ui_profiler\n```\n\n## Requirements\n\n- JupyterLab >= 3.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupyterlab-ui-profiler\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab-ui-profiler\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-ui-profiler 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 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\npip uninstall jupyterlab-ui-profiler\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/ui-profiler` within that folder.\n\n### Testing the extension\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](https://github.com/jupyterlab/ui-profiler/main/ui-tests/README.md) README.\n\n### Documentation\n\nTo build locally:\n\n```\nmake -C docs/ html SPHINXOPTS=\"-W\"\n```\n\nTo build in watch mode:\n\n```\nsphinx-autobuild docs/source docs/build/html\n```\n\n### Packaging the extension\n\nSee [RELEASE](https://github.com/jupyterlab/ui-profiler/main/RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2022, Project Jupyter Contributors 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": "JupyterLab extension for profiling UI performance",
"version": "0.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlab/ui-profiler/issues",
"Homepage": "https://github.com/jupyterlab/ui-profiler",
"Repository": "https://github.com/jupyterlab/ui-profiler.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15edc2aa98afbc931b0f6522e95035e96810380b14af3b532858570de3fe4c58",
"md5": "d2e625adae14fe632d1aef677461405e",
"sha256": "568af45f533eed532b994a213d4c3b69f9253a1ca17ad364bc60a5c1a505db34"
},
"downloads": -1,
"filename": "jupyterlab_ui_profiler-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2e625adae14fe632d1aef677461405e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 142500,
"upload_time": "2023-05-01T22:05:00",
"upload_time_iso_8601": "2023-05-01T22:05:00.079549Z",
"url": "https://files.pythonhosted.org/packages/15/ed/c2aa98afbc931b0f6522e95035e96810380b14af3b532858570de3fe4c58/jupyterlab_ui_profiler-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6ce80c10ff035ed15e96f23e25377ac83260248ecac6a8f5c4a18a583125d95",
"md5": "71da05023213dcac8ffa6c44ea7e9e30",
"sha256": "3cccc879269fb715dfaf4e1d0dcffbf825fc2c4a172cbaf89b49076b66cb4cdf"
},
"downloads": -1,
"filename": "jupyterlab_ui_profiler-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "71da05023213dcac8ffa6c44ea7e9e30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1211094,
"upload_time": "2023-05-01T22:05:05",
"upload_time_iso_8601": "2023-05-01T22:05:05.290381Z",
"url": "https://files.pythonhosted.org/packages/f6/ce/80c10ff035ed15e96f23e25377ac83260248ecac6a8f5c4a18a583125d95/jupyterlab_ui_profiler-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-01 22:05:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jupyterlab",
"github_project": "ui-profiler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-ui-profiler"
}
