Skip to content

Commit

Permalink
Correct use of dash/hyphen
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed May 14, 2024
1 parent 230c954 commit 31062ea
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# jupyterlab_gallery
# jupyterlab-gallery

[![Github Actions Status](https://github.com/nebari-dev/jupyterlab-gallery/workflows/Build/badge.svg)](https://github.com/nebari-dev/jupyterlab-gallery/actions/workflows/build.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/nebari-dev/jupyterlab-gallery/main?urlpath=lab)

A JupyterLab gallery extension for presenting and downloading examples from remote repositories

This extension is composed of a Python package named `jupyterlab_gallery`
This extension is composed of a Python package named `jupyterlab-gallery`
for the server extension and a NPM package named `jupyterlab-gallery`
for the frontend extension.

Expand All @@ -17,15 +18,15 @@ for the frontend extension.
To install the extension, execute:

```bash
pip install jupyterlab_gallery
pip install jupyterlab-gallery
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall jupyterlab_gallery
pip uninstall jupyterlab-gallery
```

## Troubleshoot
Expand Down Expand Up @@ -56,7 +57,7 @@ The `jlpm` command is JupyterLab's pinned version of

```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab_gallery directory
# Change directory to the jupyterlab-gallery directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
Expand Down Expand Up @@ -89,7 +90,7 @@ jupyter lab build --minimize=False
```bash
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_gallery
pip uninstall jupyterlab_gallery
pip uninstall jupyterlab-gallery
```

In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
Expand All @@ -113,7 +114,7 @@ jupyter labextension develop . --overwrite
To execute them, run:

```sh
pytest -vv -r ap --cov jupyterlab_gallery
pytest -vv -r ap --cov jupyterlab-gallery
```

#### Frontend tests
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["hatchling>=1.5.0", "jupyterlab>=4.0.0,<5", "hatch-nodejs-version>=0
build-backend = "hatchling.build"

[project]
name = "jupyterlab_gallery"
name = "jupyterlab-gallery"
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.8"
Expand Down

0 comments on commit 31062ea

Please sign in to comment.