Skip to content

Commit dafc920

Browse files
danyeawdanyeaw
authored
Migrate from setup.py to pyproject.toml (#315)
* Add npm scripts for building * Convert project to use hatch jupyter builder * Replace setup.py jsversion with tbump * Fix javascript version not consistent with project version * Update manual release instructions * Update cache hash key * Fix issues with build scripts * Fix hatch-jupyter-build requires Python 3.8+ * Move copy build step to js script * Apply pyproject-fmt
1 parent 4e81dab commit dafc920

16 files changed

+258
-946
lines changed

‎.github/workflows/check-release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
uses: actions/cache@v4
2929
with:
3030
path: ${{ steps.pip-cache.outputs.dir }}
31-
key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
31+
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
3232
restore-keys: |
3333
${{ runner.os }}-pip-
3434
${{ runner.os }}-pip-

‎.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
uses: actions/cache@v4
3232
with:
3333
path: ${{ steps.pip-cache.outputs.dir }}
34-
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}
34+
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
3535
restore-keys: |
3636
${{ runner.os }}-pip-${{ matrix.python-version }}-
3737
${{ runner.os }}-pip-

‎.github/workflows/js.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ jobs:
4646
if: startsWith(runner.os, 'Linux')
4747
with:
4848
path: ~/.cache/pip
49-
key: ${{ runner.os }}-pip-${{ matrix.python }}-${{ hashFiles('**/requirements.txt', 'setup.py') }}
49+
key: ${{ runner.os }}-pip-${{ matrix.python }}-${{ hashFiles('pyproject.toml') }}
5050
restore-keys: |
5151
${{ runner.os }}-pip-${{ matrix.python }}
5252

‎.github/workflows/playwright.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
fail-fast: false
1313
matrix:
1414
os: [ubuntu-22.04, macos-13]
15-
python-version: [ '3.7', '3.8', '3.9', '3.10']
15+
python-version: [ '3.8', '3.9', '3.10', '3.11' ]
1616
steps:
1717
- name: Checkout
1818
uses: actions/checkout@v4

‎.github/workflows/pythonpackage.yml

+3-8
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,7 @@ jobs:
1313
fail-fast: false
1414
matrix:
1515
os: [ubuntu-22.04, macos-13, windows-2022]
16-
python-version: ["3.7", "3.8", "3.9", "3.10"]
17-
exclude:
18-
- os: ubuntu-22.04
19-
python-version: "3.7"
20-
- os: macos-13
21-
python-version: "3.7"
16+
python-version: [ '3.8', '3.9', '3.10', '3.11' ]
2217
steps:
2318
- name: Checkout
2419
uses: actions/checkout@v4
@@ -57,8 +52,8 @@ jobs:
5752
# - name: Base Setup
5853
# uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
5954
# with:
60-
# python_version: "3.7"
61-
# - name: Install miniumum versions
55+
# python_version: "3.8"
56+
# - name: Install minimum versions
6257
# uses: jupyterlab/maintainer-tools/.github/actions/install-minimums@v1
6358
# - name: Run the unit tests
6459
# run: pytest -vv || pytest -vv --lf

‎MANIFEST.in

-50
This file was deleted.

‎RELEASE.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,12 @@ yet support "next" or "patch" when dev versions are used.
99

1010
## Manual Release
1111

12-
To create a release, update the version number in `nbclassic/__version__.py`, then run the following:
12+
To create a release, run the following:
1313

1414
```
1515
git clean -dffx
16-
python setup.py sdist
17-
python setup.py bdist_wheel
18-
export script_version=`python setup.py --version 2>/dev/null`
19-
git commit -a -m "Release $script_version"
20-
git tag $script_version
21-
git push --all
22-
git push --tags
16+
python -m build
17+
tbump <new version number>
2318
pip install twine
2419
twine check dist/*
2520
twine upload dist/*

‎git-hooks/post-checkout

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ if [[
1111
! -z "$(git diff $PREVIOUS_HEAD nbclassic/static/*/js/**.js)"
1212
]]; then
1313
echo "rebuilding javascript"
14-
python setup.py js || echo "fail to rebuild javascript"
14+
npm run build:js || echo "fail to rebuild javascript"
1515
fi
1616

1717
if [[
1818
! -z "$(git diff $PREVIOUS_HEAD nbclassic/static/*/less/**.less)"
1919
]]; then
2020
echo "rebuilding css sourcemaps"
21-
python setup.py css || echo "fail to recompile css"
21+
npm run build:css || echo "fail to recompile css"
2222
fi

‎nbclassic/_version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@
1515
parts.append(match['rest'])
1616
version_info = tuple(parts)
1717

18-
# Downstream maintainer, when running `python.setup.py jsversion`,
19-
# the version string is propagated to the JavaScript files, do not forget to
18+
# Downstream maintainer, when running `tbump <new version>`,
19+
# the version string is propagated to the JavaScript files, do not forget to
2020
# patch the JavaScript files in `.postN` release done by distributions.

‎nbclassic/static/base/js/namespace.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ define(function(){
7373
// tree
7474
jglobal('SessionList','tree/js/sessionlist');
7575

76-
Jupyter.version = "1.2.0";
76+
Jupyter.version = "1.3.0.dev0";
7777
Jupyter._target = '_blank';
7878

7979
return Jupyter;

‎package.json

+21-3
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,29 @@
1010
"url": "https://github.com/jupyter/nbclassic.git"
1111
},
1212
"scripts": {
13-
"bower": "bower install",
14-
"build": "python setup.py js css",
13+
"bower:copy-marked": "node tools/copy-marked.js",
14+
"bower": "bower install && npm run bower:copy-marked",
1515
"build:webpack": "webpack --mode production",
16+
"build:notebook": "node tools/build-main.js notebook",
17+
"build:tree": "node tools/build-main.js tree",
18+
"build:edit": "node tools/build-main.js edit",
19+
"build:terminal": "node tools/build-main.js terminal",
20+
"build:auth": "node tools/build-main.js auth",
21+
"build:fr-translation": "po2json -p -F -f jed1.x -d nbjs nbclassic/i18n/fr_FR/LC_MESSAGES/nbjs.po nbclassic/i18n/fr_FR/LC_MESSAGES/nbjs.json",
22+
"build:ja-translation": "po2json -p -F -f jed1.x -d nbjs nbclassic/i18n/ja_JP/LC_MESSAGES/nbjs.po nbclassic/i18n/ja_JP/LC_MESSAGES/nbjs.json",
23+
"build:nl-translation": "po2json -p -F -f jed1.x -d nbjs nbclassic/i18n/nl/LC_MESSAGES/nbjs.po nbclassic/i18n/nl/LC_MESSAGES/nbjs.json",
24+
"build:ru-translation": "po2json -p -F -f jed1.x -d nbjs nbclassic/i18n/ru_RU/LC_MESSAGES/nbjs.po nbclassic/i18n/ru_RU/LC_MESSAGES/nbjs.json",
25+
"build:zh-translation": "po2json -p -F -f jed1.x -d nbjs nbclassic/i18n/zh_CN/LC_MESSAGES/nbjs.po nbclassic/i18n/zh_CN/LC_MESSAGES/nbjs.json",
26+
"build:translations": "npm run build:fr-translation && npm run build:ja-translation && npm run build:nl-translation && npm run build:ru-translation && npm run build:zh-translation",
27+
"build:js": "npm run build:notebook && npm run build:tree && npm run build:edit && npm run build:terminal && npm run build:auth && npm run build:translations",
28+
"build:css-ipython": "lessc --source-map --include-path='nbclassic/static/style' nbclassic/static/style/ipython.less nbclassic/static/style/ipython.min.css",
29+
"build:css-style": "lessc --source-map --include-path='nbclassic/static/style' nbclassic/static/style/style.less nbclassic/static/style/style.min.css",
30+
"build:css": "npm run build:css-ipython && npm run build:css-style",
31+
"build": "npm run bower && npm run build:webpack && npm run build:js && npm run build:css",
1632
"build:watch": "npm run watch",
17-
"watch": "onchange 'nbclassic/static/**/!(*.min).js' 'nbclassic/static/**/*.less' 'bower.json' -- npm run build"
33+
"watch:css": "onchange 'nbclassic/static/**/*.less' -- npm run build:css",
34+
"watch:js": "onchange 'nbclassic/static/**/!(*.min).js' 'bower.json' -- npm run build:js",
35+
"watch": "npm-run-all --parallel watch:*"
1836
},
1937
"devDependencies": {
2038
"@babel/core": "^7.15.0",

0 commit comments

Comments
 (0)