https://github.com/jupytercalpoly/jupyterlab-code-snippets
Save, reuse, and share code snippets using JupyterLab Code Snippets!
https://github.com/jupytercalpoly/jupyterlab-code-snippets
code-snippet jupyterlab snippet
Last synced: 3 months ago
JSON representation
Save, reuse, and share code snippets using JupyterLab Code Snippets!
- Host: GitHub
- URL: https://github.com/jupytercalpoly/jupyterlab-code-snippets
- Owner: jupytercalpoly
- License: other
- Created: 2020-06-17T20:38:36.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T17:03:19.000Z (about 2 years ago)
- Last Synced: 2025-03-30T03:05:18.857Z (3 months ago)
- Topics: code-snippet, jupyterlab, snippet
- Language: JavaScript
- Homepage: https://jupyterlab-code-snippets-documentation.readthedocs.io
- Size: 79.3 MB
- Stars: 166
- Watchers: 4
- Forks: 24
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JupyterLab Code Snippet
## Save, reuse, and share code snippets using JupyterLab Code Snippets
 [](https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-code-snippets.git/master?urlpath=lab) [](https://badge.fury.io/js/jupyterlab-code-snippets 'View this project on npm') [](https://badge.fury.io/py/jupyterlab-code-snippets) [](https://anaconda.org/conda-forge/jupyterlab-code-snippets) [](https://opensource.org/licenses/BSD-3-Clause) [](https://jupyterlab-code-snippets-documentation.readthedocs.io/en/latest/?badge=latest)
This extension is a derivative of [Elyra](https://github.com/elyra-ai/elyra)'s original design and further developed by Jupyter Cal Poly Team.
Read [Press Release](./PRESSRELEASE.md) for more information.
Check out [the Current Progress](./PROGRESS.md) to keep up with our feature updates!
This extension is composed of a NPM package named `jupyterlab-code-snippets`
for the frontend extension.
## Requirements
- JupyterLab >= 3.5.3
- Python >= 3.7
## Install
Install using jupyter:
```bash
jupyter labextension install jupyterlab-code-snippets
```
Install using pip:
```bash
pip install jupyterlab-code-snippets
```
```bash
conda install -c conda-forge jupyterlab-code-snippets
```
## Troubleshoot
If it is installed, try:
```bash
jupyter lab clean
jupyter lab build
```
## Contributing
### Install
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
# Move to jupyter-lab-code-snippets directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```
Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
### Uninstall
```bash
jupyter labextension uninstall jupyterlab-code-snippets
```
OR
```bash
pip uninstall jupyterlab-code-snippets
```