Skip to content

Commit f869c7a

Browse files
committed
Update README.md
1 parent 9573517 commit f869c7a

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ A JupyterLab extension that passes the relative path of the current notebook to
1313
To install the extension, execute:
1414

1515
```bash
16-
pip install nbname
16+
uv pip install git+https://github.com/StructuralPython/nbname.git
1717
```
1818

1919
## Uninstall
2020

2121
To remove the extension, execute:
2222

2323
```bash
24-
pip uninstall nbname
24+
uv pip uninstall nbname
2525
```
2626

2727
## Contributing
@@ -39,26 +39,26 @@ The `jlpm` command is JupyterLab's pinned version of
3939
# Change directory to the nbname directory
4040

4141
# Set up a virtual environment and install package in development mode
42-
python -m venv .venv
42+
uv venv --seed
4343
source .venv/bin/activate
44-
pip install --editable "."
44+
uv sync
4545

4646
# Link your development version of the extension with JupyterLab
4747
jupyter labextension develop . --overwrite
4848

4949
# Rebuild extension Typescript source after making changes
5050
# IMPORTANT: Unlike the steps above which are performed only once, do this step
5151
# every time you make a change.
52-
jlpm build
52+
uv run jlpm run build
5353
```
5454

5555
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.
5656

5757
```bash
5858
# Watch the source directory in one terminal, automatically rebuilding when needed
59-
jlpm watch
59+
uv run jlpm watch
6060
# Run JupyterLab in another terminal
61-
jupyter lab
61+
uv run jupyter lab
6262
```
6363

6464
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).

0 commit comments

Comments
 (0)