https://github.com/mljar/variable-inspector
Explore variables in Jupyter notebooks
https://github.com/mljar/variable-inspector
data-science jupyter jupyterlab jupyterlab-extension mljar python
Last synced: over 1 year ago
JSON representation
Explore variables in Jupyter notebooks
- Host: GitHub
- URL: https://github.com/mljar/variable-inspector
- Owner: mljar
- License: agpl-3.0
- Created: 2025-01-22T13:17:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T14:17:14.000Z (over 1 year ago)
- Last Synced: 2025-02-28T16:42:18.477Z (over 1 year ago)
- Topics: data-science, jupyter, jupyterlab, jupyterlab-extension, mljar, python
- Language: TypeScript
- Homepage: https://mljar.com
- Size: 1.13 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jupyter Variable Inspector
The Variable Inspector is a Jupyter Lab extension designed to help you manage and track variables within your notebook. It displays all your variables in one convenient location, allowing you to see their names, values, types, shapes, and sizes in real-time. This feature makes it easier to work without the need to manually print or check your variables. **It is for Python only.**.
Install the extension using `pip` by following the instructions below. It’s also available in our desktop app, [MLJAR Studio](https://mljar.com), which is designed to make Python easier for beginners.
## Features
### Display variables
Explore all available variables in the current notebook as a list.
### Display DataFrames
You can preview the DataFrame values as an interactive table.
### Display DataFrames with updates
The preview of DataFrame will be automatically refreshed when you change it in the Python code.
### Customize displayed columns
You can select which properties of the variables you'd like to display:
### Automatic or manual refresh
The list of variables will automatically update whenever you execute a cell. However, you can choose the Manual Refresh option to update the list at your convenience.
### Dark theme
If you prefer a darker look, a Dark Theme is also available!
## Variable Inspector requirements
- JupyterLab >= 4.0.0
## Install extension
To install the extension, execute:
```bash
pip install variable_inspector
```
## Uninstall extension
To remove the extension, execute:
```bash
pip uninstall variable_inspector
```
## 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 variable_inspector 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 variable_inspector
```
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 `variable-inspector` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)