Skip to content

Commit 2467fd2

Browse files
authored
Rename to glue-jupyterlab (#113)
1 parent c366931 commit 2467fd2

35 files changed

+84
-85
lines changed

.github/workflows/build.yml

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ jobs:
3131
set -eux
3232
python -m pip install .[test]
3333
34-
pytest -vv -r ap --cov gluepyter
34+
pytest -vv -r ap --cov glue_jupyterlab
3535
jupyter server extension list
36-
jupyter server extension list 2>&1 | grep -ie "gluepyter.*OK"
36+
jupyter server extension list 2>&1 | grep -ie "glue_jupyterlab.*OK"
3737
3838
jupyter labextension list
39-
jupyter labextension list 2>&1 | grep -ie "gluepyter.*OK"
39+
jupyter labextension list 2>&1 | grep -ie "glue-jupyterlab.*OK"
4040
python -m jupyterlab.browser_check
4141
4242
- name: Package the extension
@@ -45,13 +45,13 @@ jobs:
4545
4646
pip install build
4747
python -m build
48-
pip uninstall -y "gluepyter" jupyterlab
48+
pip uninstall -y "glue-jupyterlab" jupyterlab
4949
5050
- name: Upload extension packages
5151
uses: actions/upload-artifact@v3
5252
with:
5353
name: extension-artifacts
54-
path: dist/gluepyter*
54+
path: dist/*
5555
if-no-files-found: error
5656

5757
test_isolated:
@@ -76,14 +76,13 @@ jobs:
7676
sudo rm -rf $(which node)
7777
sudo rm -rf $(which node)
7878
79-
pip install "jupyterlab>=4.0.0,<5" gluepyter*.whl
80-
79+
pip install "jupyterlab>=4.0.0,<5" glue_jupyterlab*.whl
8180
8281
jupyter server extension list
83-
jupyter server extension list 2>&1 | grep -ie "gluepyter.*OK"
82+
jupyter server extension list 2>&1 | grep -ie "glue_jupyterlab.*OK"
8483
8584
jupyter labextension list
86-
jupyter labextension list 2>&1 | grep -ie "gluepyter.*OK"
85+
jupyter labextension list 2>&1 | grep -ie "glue-jupyterlab.*OK"
8786
python -m jupyterlab.browser_check --no-browser-test
8887
8988
integration-tests:
@@ -109,7 +108,7 @@ jobs:
109108
- name: Install the extension
110109
run: |
111110
set -eux
112-
python -m pip install "jupyterlab>=4.0.0,<5" gluepyter*.whl
111+
python -m pip install "jupyterlab>=4.0.0,<5" glue_jupyterlab*.whl
113112
114113
- name: Install dependencies
115114
working-directory: ui-tests
@@ -137,7 +136,7 @@ jobs:
137136
if: always()
138137
uses: actions/upload-artifact@v3
139138
with:
140-
name: gluepyter-playwright-tests
139+
name: glue-jupyterlab-playwright-tests
141140
path: |
142141
ui-tests/test-results
143142
ui-tests/playwright-report

.github/workflows/check-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ jobs:
2424
- name: Upload Distributions
2525
uses: actions/upload-artifact@v3
2626
with:
27-
name: gluepyter-releaser-dist-${{ github.run_number }}
27+
name: glue-jupyterlab-releaser-dist-${{ github.run_number }}
2828
path: .jupyter_releaser_checkout/dist

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ node_modules/
77
*.egg-info/
88
.ipynb_checkpoints
99
*.tsbuildinfo
10-
gluepyter/labextension
10+
glue_jupyterlab/labextension
1111
# Version file is handled by hatchling
12-
gluepyter/_version.py
12+
glue_jupyterlab/_version.py
1313

1414
# Integration tests
1515
ui-tests/test-results/

.prettierignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ node_modules
33
**/lib
44
**/package.json
55
!/package.json
6-
gluepyter
6+
glue-jupyterlab

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Gluepyter
1+
# glue-jupyterlab
22

33
The Glue application for JupyterLab
44

5-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/QuantStack/gluepyter/stable?urlpath=lab)
5+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/QuantStack/glue-jupyterlab/stable?urlpath=lab)
66

77
## Overview
88

99
Glue is an open-source data exploration tool that allows users to visualize and analyze data in a way that is intuitive and easy to understand. This JupyterLab extension brings Glue's data exploration capabilities directly into JupyterLab, allowing users to seamlessly analyze and visualize data without leaving their JupyterLab environment.
1010

11-
![gluepyter](gluepyter.png)
11+
![glue-jupyterlab](glue-jupyterlab.png)
1212

1313
## What is the difference with Glue-jupyter?
1414

1515
[`glue-jupyter`](https://github.com/glue-viz/glue-jupyter) is a library for creating a Glue "application" object directly in Python from a Jupyter Notebook (either using classic Notebook or JupyterLab) and create Glue "viewers" using tools like bqplot or Matplotlib.
1616

17-
Gluepyter is an extension that allows opening Glue sessions directly from the JupyterLab application. It reuses components of glue-jupyter for creating the viewers and the underlying Glue application object.
17+
glue-jupyterlab is an extension that allows opening Glue sessions directly from the JupyterLab application. It reuses components of glue-jupyter for creating the viewers and the underlying Glue application object.
1818

1919
## Requirements
2020

@@ -25,15 +25,15 @@ Gluepyter is an extension that allows opening Glue sessions directly from the Ju
2525
To install the extension, execute:
2626

2727
```bash
28-
pip install gluepyter
28+
pip install glue-jupyterlab
2929
```
3030

3131
## Uninstall
3232

3333
To remove the extension, execute:
3434

3535
```bash
36-
pip uninstall gluepyter
36+
pip uninstall glue-jupyterlab
3737
```
3838

3939
## Troubleshoot
@@ -64,13 +64,13 @@ The `jlpm` command is JupyterLab's pinned version of
6464

6565
```bash
6666
# Clone the repo to your local environment
67-
# Change directory to the gluepyter directory
67+
# Change directory to the glue-jupyterlab directory
6868
# Install package in development mode
6969
pip install -e ".[test]"
7070
# Link your development version of the extension with JupyterLab
7171
jupyter labextension develop . --overwrite
7272
# Server extension must be manually installed in develop mode
73-
jupyter server extension enable gluepyter
73+
jupyter server extension enable glue-jupyterlab
7474
# Rebuild extension Typescript source after making changes
7575
jlpm build
7676
```
@@ -96,13 +96,13 @@ jupyter lab build --minimize=False
9696

9797
```bash
9898
# Server extension must be manually disabled in develop mode
99-
jupyter server extension disable gluepyter
100-
pip uninstall gluepyter
99+
jupyter server extension disable glue-jupyterlab
100+
pip uninstall glue-jupyterlab
101101
```
102102

103103
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
104104
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
105-
folder is located. Then you can remove the symlink named `gluepyter` within that folder.
105+
folder is located. Then you can remove the symlink named `glue-jupyterlab` within that folder.
106106

107107
### Testing the extension
108108

@@ -121,7 +121,7 @@ jupyter labextension develop . --overwrite
121121
To execute them, run:
122122

123123
```sh
124-
pytest -vv -r ap --cov gluepyter
124+
pytest -vv -r ap --cov glue-jupyterlab
125125
```
126126

127127
#### Frontend tests

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Making a new release of gluepyter
1+
# Making a new release of glue-jupyterlab
22

33
The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
44

binder/postBuild

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ _("jupyter", "server", "extension", "list")
4141
_("jupyter", "labextension", "list")
4242

4343

44-
print("JupyterLab with gluepyter is ready to run with:\n")
44+
print("JupyterLab with glue-jupyterlab is ready to run with:\n")
4545
print("\tjupyter lab\n")

conftest.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55

66
@pytest.fixture
77
def jp_server_config(jp_server_config):
8-
return {"ServerApp": {"jpserver_extensions": {"gluepyter": True}}}
8+
return {"ServerApp": {"jpserver_extensions": {"glue_jupyterlab": True}}}
File renamed without changes.

gluepyter/__init__.py renamed to glue_jupyterlab/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33

44
def _jupyter_labextension_paths():
5-
return [{"src": "labextension", "dest": "gluepyter"}]
5+
return [{"src": "labextension", "dest": "glue-jupyterlab"}]
66

77

88
def _jupyter_server_extension_points():
9-
return [{"module": "gluepyter"}]
9+
return [{"module": "glue_jupyterlab"}]
1010

1111

1212
def _load_jupyter_server_extension(server_app):
@@ -18,7 +18,7 @@ def _load_jupyter_server_extension(server_app):
1818
JupyterLab application instance
1919
"""
2020
setup_handlers(server_app.web_app)
21-
name = "gluepyter"
21+
name = "glue_jupyterlab"
2222
server_app.log.info(f"Registered {name} server extension")
2323

2424

gluepyter/glue_session.py renamed to glue_jupyterlab/glue_session.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ def _init_ydoc(self) -> None:
339339
"""
340340

341341
self._sessionYDoc = Y.YDoc()
342-
# Import `gluepyter.glue_ydoc.YGlue`` class through `jupyter_ydoc``
342+
# Import `glue-jupyterlab.glue_ydoc.YGlue`` class through `jupyter_ydoc``
343343
self._document: YGlue = ydocs.get("glu")(self._sessionYDoc)
344344
self._document.observe(self._on_document_change)
345345
self._ywidget = Widget(
File renamed without changes.
File renamed without changes.

gluepyter/handlers.py renamed to glue_jupyterlab/handlers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ def setup_handlers(web_app):
1919
host_pattern = ".*$"
2020

2121
base_url = web_app.settings["base_url"]
22-
route_pattern = url_path_join(base_url, "gluepyter", "advanced-links")
22+
route_pattern = url_path_join(base_url, "glue-jupyterlab", "advanced-links")
2323
handlers = [(route_pattern, AdvancedLinkHandler)]
2424
web_app.add_handlers(host_pattern, handlers)

glue_jupyterlab/tests/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""Python unit tests for glue-jupyterlab."""

gluepyter/tests/conftest.py renamed to glue_jupyterlab/tests/conftest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
import pytest
33
from pathlib import Path
44
from jupyter_ydoc import ydocs
5-
from gluepyter.glue_session import SharedGlueSession
6-
from gluepyter.glue_ydoc import COMPONENT_LINK_TYPE, IDENTITY_LINK_FUNCTION
5+
from glue_jupyterlab.glue_session import SharedGlueSession
6+
from glue_jupyterlab.glue_ydoc import COMPONENT_LINK_TYPE, IDENTITY_LINK_FUNCTION
77

88

99
@pytest.fixture

gluepyter/tests/test_glue_session.py renamed to glue_jupyterlab/tests/test_glue_session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
from copy import deepcopy
33
from pathlib import Path
44
from ipywidgets import Output
5-
from gluepyter.glue_session import SharedGlueSession
6-
from gluepyter.glue_utils import nested_compare
5+
from glue_jupyterlab.glue_session import SharedGlueSession
6+
from glue_jupyterlab.glue_utils import nested_compare
77

88

99
def test_init(session_path):

gluepyter/tests/test_handlers.py renamed to glue_jupyterlab/tests/test_handlers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
async def test_get_advanced_links_list(jp_fetch):
55
# When
6-
response = await jp_fetch("gluepyter", "advanced-links")
6+
response = await jp_fetch("glue-jupyterlab", "advanced-links")
77

88
# Then
99
assert response.code == 200
File renamed without changes.

gluepyter/tests/__init__.py

Lines changed: 0 additions & 1 deletion
This file was deleted.

install.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"packageManager": "python",
3-
"packageName": "gluepyter",
4-
"uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package gluepyter"
3+
"packageName": "glue-jupyterlab",
4+
"uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package glue-jupyterlab"
55
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"NotebookApp": {
33
"nbserver_extensions": {
4-
"gluepyter": true
4+
"glue_jupyterlab": true
55
}
66
}
77
}
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"ServerApp": {
33
"jpserver_extensions": {
4-
"gluepyter": true
4+
"glue_jupyterlab": true
55
}
66
}
77
}

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "gluepyter",
2+
"name": "glue-jupyterlab",
33
"version": "0.1.0",
44
"description": "A JupyterLab extension for glue-viz",
55
"keywords": [
66
"jupyter",
77
"jupyterlab",
88
"jupyterlab-extension"
99
],
10-
"homepage": "https://github.com/QuantStack/gluepyter",
10+
"homepage": "https://github.com/QuantStack/glue-jupyterlab",
1111
"bugs": {
12-
"url": "https://github.com/QuantStack/gluepyter/issues"
12+
"url": "https://github.com/QuantStack/glue-jupyterlab/issues"
1313
},
1414
"license": "BSD-3-Clause",
1515
"author": {
@@ -25,7 +25,7 @@
2525
"style": "style/index.css",
2626
"repository": {
2727
"type": "git",
28-
"url": "https://github.com/QuantStack/gluepyter.git"
28+
"url": "https://github.com/QuantStack/glue-jupyterlab.git"
2929
},
3030
"scripts": {
3131
"build": "jlpm build:schema && jlpm build:lib && jlpm build:labextension:dev",
@@ -38,7 +38,7 @@
3838
"clean": "jlpm clean:lib",
3939
"clean:lib": "rimraf lib tsconfig.tsbuildinfo",
4040
"clean:lintcache": "rimraf .eslintcache .stylelintcache",
41-
"clean:labextension": "rimraf gluepyter/labextension gluepyter/_version.py",
41+
"clean:labextension": "rimraf glue_jupyterlab/labextension glue_jupyterlab/_version.py",
4242
"clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
4343
"eslint": "jlpm eslint:check --fix",
4444
"eslint:check": "eslint . --cache --ext .ts,.tsx",
@@ -116,12 +116,12 @@
116116
"pip"
117117
],
118118
"base": {
119-
"name": "gluepyter"
119+
"name": "glue-jupyterlab"
120120
}
121121
}
122122
},
123123
"extension": true,
124-
"outputDir": "gluepyter/labextension",
124+
"outputDir": "glue_jupyterlab/labextension",
125125
"sharedPackages": {
126126
"yjs": {
127127
"bundled": false,

0 commit comments

Comments
 (0)