Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deshaw/jupyterlab-execute-time
A JupyterLab extension for displaying cell timings
https://github.com/deshaw/jupyterlab-execute-time
Last synced: about 1 month ago
JSON representation
A JupyterLab extension for displaying cell timings
- Host: GitHub
- URL: https://github.com/deshaw/jupyterlab-execute-time
- Owner: deshaw
- License: bsd-3-clause
- Created: 2020-04-07T22:27:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T13:37:43.000Z (8 months ago)
- Last Synced: 2024-04-14T19:10:14.799Z (8 months ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 500 KB
- Stars: 331
- Watchers: 8
- Forks: 46
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 11% open · ⏱️ 12.08.2022): (JupyterLab扩展)
- best-of-jupyter - GitHub - 18% open · ⏱️ 12.09.2024): (JupyterLab Extensions)
README
# jupyterlab-execute-time
[![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]
Display cell timings in Jupyter Lab
This is inspired by the notebook version [here](https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/src/jupyter_contrib_nbextensions/nbextensions/execute_time).
## Requirements
- JupyterLab >= 3.0
## Install
To install this package with [`pip`](https://pip.pypa.io/en/stable/) run
```bash
pip install jupyterlab_execute_time
```
To install this package with [`conda`](https://docs.conda.io/en/latest/) run
```bash
conda install -c conda-forge jupyterlab_execute_time
```
Note: By default, if this extension is enabled, it will automatically change your settings to record timing in the notebook metadata when it is loaded. If this fails, you can do this manually via Settings->Advanced Settings Editor->Notebook: `{"recordTiming": true}`. This is a notebook metadata setting and not a plugin setting. The plugin just displays this data.
## 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_execute_time 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
git tag vX.Z.Y
git push && git push --tags
```
3. Create the artifacts
```
rm -rf dist build jupyterlab_execute_time/labextension
jlpm run build
python setup.py sdist bdist_wheel
```
4. Test this against the test pypi. You can then install from here to test as well:
```
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_execute_time
```
5. Upload this to pypi:
```
twine upload dist/*
```
### Uninstall
```bash
pip uninstall jupyterlab_execute_time
```
## History
This plugin was contributed back to the community by the [D. E. Shaw group](https://www.deshaw.com/).
## License
This project is released under a [BSD-3-Clause license](https://github.com/deshaw/jupyterlab-execute-time/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-execute-time
[pypi-image]: https://img.shields.io/pypi/v/jupyterlab-execute-time
[pypi-dm-image]: https://img.shields.io/pypi/dm/jupyterlab-execute-time
[github-status-image]: https://github.com/deshaw/jupyterlab-execute-time/workflows/Build/badge.svg
[github-status-url]: https://github.com/deshaw/jupyterlab-execute-time/actions?query=workflow%3ABuild
[binder-image]: https://mybinder.org/badge_logo.svg
[binder-url]: https://mybinder.org/v2/gh/deshaw/jupyterlab-execute-time.git/master?urlpath=lab%2Ftree%2Fnotebooks%2Findex.ipynb