Skip to content

Commit 96671df

Browse files
authored
Update to jupyter-packaging 0.10 (jupyter#179)
* Update to jupyter-packaging 0.10 * Update to jupyter-packaging 0.10 on CI * Update pyproject metadata * Update target * Update targets * Update build command * Update MANIFEST.in * Fix build backend * Add build:prod command to packages * Update RELEASE.md * Enable server extension in dev mode * Enable for the notebook server * Fix typo * Add jupyter labextension develop . to the Binder * Update dev instructions
1 parent b2ca240 commit 96671df

File tree

19 files changed

+112
-97
lines changed

19 files changed

+112
-97
lines changed

.github/workflows/build.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
- name: Install dependencies
4848
run: |
4949
python -m pip install --upgrade pip wheel
50-
python -m pip install jupyter_packaging
50+
python -m pip install jupyter_packaging~=0.10
5151
- name: Install the package
5252
run: |
5353
python -m pip install .
@@ -82,10 +82,10 @@ jobs:
8282
- name: Install dependencies
8383
run: |
8484
python -m pip install --upgrade pip wheel
85-
python -m pip install setuptools jupyter_packaging "jupyterlab>=3,<4"
85+
python -m pip install setuptools jupyter_packaging~=0.10 "jupyterlab>=3,<4" build
8686
- name: Build pypi distributions
8787
run: |
88-
python setup.py sdist bdist_wheel
88+
python -m build
8989
- name: Build npm distributions
9090
run: |
9191
mkdir pkgs

.github/workflows/buildutils.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
architecture: 'x64'
2828
- name: Install dependencies
2929
run: |
30-
python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9 pip
30+
python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.10 pip
3131
jlpm
3232
jlpm run build
3333
- name: Configure git identity to commit
@@ -72,7 +72,7 @@ jobs:
7272
architecture: 'x64'
7373
- name: Install dependencies
7474
run: |
75-
python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9 pip
75+
python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.10 pip
7676
jlpm
7777
jlpm run build
7878
- name: Publish to npm in dry-run mode

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
- name: Install dependencies
4848
run: |
4949
python -m pip install --upgrade pip wheel
50-
python -m pip install jupyter_packaging
50+
python -m pip install jupyter_packaging~=0.10
5151
- name: Install the package
5252
run: |
5353
python -m pip install .
@@ -82,10 +82,10 @@ jobs:
8282
- name: Install dependencies
8383
run: |
8484
python -m pip install --upgrade pip wheel
85-
python -m pip install setuptools jupyter_packaging "jupyterlab>=3,<4"
85+
python -m pip install setuptools jupyter_packaging~=0.10 "jupyterlab>=3,<4" build
8686
- name: Build pypi distributions
8787
run: |
88-
python setup.py sdist bdist_wheel
88+
python -m build
8989
- name: Build npm distributions
9090
run: |
9191
mkdir pkgs
@@ -184,7 +184,7 @@ jobs:
184184
architecture: 'x64'
185185
- name: Install dependencies
186186
run: |
187-
python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9 pip
187+
python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.10 pip
188188
jlpm
189189
jlpm run build
190190
- uses: actions/download-artifact@v2

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ conda activate retrolab
2323

2424
# Install package in development mode
2525
pip install -e .
26+
27+
# Link the RetroLab JupyterLab extension
28+
jupyter labextension develop . --overwrite
29+
30+
# Enable the server extension
31+
jupyter server extension enable retrolab
2632
```
2733

2834
`retrolab` follows a monorepo structure. To build all the packages at once:

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
include LICENSE
2-
include README.md
2+
include *.md
33
include pyproject.toml
44
include jupyter-config/retrolab.json
55

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Make sure the `dist/` folder is empty.
6363
- `jlpm`
6464
- `jlpm run lerna version x.y.z --no-push --amend --force-publish`
6565

66-
4. Run: `python setup.py sdist bdist_wheel`
66+
4. Run: `python -m pip install build && python -m build`
6767
5. Double check the size of the bundles in the `dist/` folder
6868
6. Test the release by installing the wheel or sdist: `python -m pip install ./dist/retrolab-x.y.z-py3-none-any.whl
6969
7. `export TWINE_USERNAME=mypypi_username`

binder/postBuild

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ set -euo pipefail
33

44
jlpm && jlpm run build
55
python -m pip install -e .
6+
jupyter labextension develop . --overwrite
7+
jupyter server extension enable retrolab
8+
jupyter serverextension enable retrolab

packages/application-extension/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsc -b",
35+
"build:prod": "tsc -b",
3536
"clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
3637
"docs": "typedoc src",
3738
"prepublishOnly": "npm run build",

packages/application/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
],
3232
"scripts": {
3333
"build": "tsc -b",
34+
"build:prod": "tsc -b",
3435
"build:test": "tsc --build tsconfig.test.json",
3536
"clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
3637
"docs": "typedoc src",

packages/docmanager-extension/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
],
3333
"scripts": {
3434
"build": "tsc -b",
35+
"build:prod": "tsc -b",
3536
"clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
3637
"docs": "typedoc src",
3738
"prepublishOnly": "npm run build",

0 commit comments

Comments
 (0)