Uses hatch

Author: hbcarlos

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
     - name: Install dependencies
-      run: python -m pip install -U check-manifest jupyterlab
+      run: python -m pip install -U jupyterlab~=3.4
 
     - name: Build the extension
       run: |
@@ -30,8 +30,6 @@ jobs:
         jupyter labextension list 2>&1 | grep -ie "jupyterlab-blockly-extension.*OK"
         python -m jupyterlab.browser_check
 
-        check-manifest -v
-
         pip install build
         python -m build --sdist
         cp dist/*.tar.gz myextension.tar.gz

.github/workflows/check-release.yml

@@ -1,63 +1,27 @@
 name: Check Release
 on:
   push:
-    branches:
-      - main
+    branches: ["main"]
   pull_request:
-    branches:
-      - main
-
-permissions:
-  contents: write
+    branches: ["*"]
 
 jobs:
   check_release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-          architecture: 'x64'
-      - name: Install node
-        uses: actions/setup-node@v2
-        with:
-          node-version: '14.x'
-      
-      
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      - name: Cache pip
-        uses: actions/cache@v1
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('package.json') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Cache checked links
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pytest-link-check
-          key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/.md') }}-md-links
-          restore-keys: |
-            ${{ runner.os }}-linkcheck-
-      - name: Upgrade packaging dependencies
-        run: |
-          pip install --upgrade pip setuptools wheel jupyter-packaging~=0.10 --user
+        uses: actions/checkout@v3
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install Dependencies
         run: |
-          pip install .
+          pip install -e .
       - name: Check Release
-        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-      
       - name: Upload Distributions
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
-          name: jupyterlab_blockly-releaser-dist-${{ github.run_number }}
+          name: jupyterlab_blockly-releaser-dist-${{ '{{ github.run_number }}' }}
           path: .jupyter_releaser_checkout/dist

MANIFEST.in

@@ -1,6 +1,6 @@
 {
   "lerna": "5.1.0",
-  "version": "independent",
+  "version": "0.2.1",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

lerna.json

@@ -1,7 +1,22 @@
 {
   "name": "jupyterlab-blockly-root",
-  "version": "0.1.0",
   "private": true,
+  "version": "0.2.1",
+  "description": "Blockly extension for JupyterLab.",
+  "keywords": [
+    "jupyter",
+    "jupyterlab",
+    "jupyterlab-extension"
+  ],
+  "homepage": "https://github.com/quantstack/jupyterlab-blockly",
+  "bugs": {
+    "url": "https://github.com/quantstack/jupyterlab-blockly/issues"
+  },
+  "license": "BSD-3-Clause",
+  "author": {
+    "name": "quantstack",
+    "email": ""
+  },
   "workspaces": {
     "packages": [
       "packages/*"

package.json

@@ -1,24 +1,77 @@
 [build-system]
-requires = ["jupyter_packaging~=0.10,<2", "jupyterlab~=3.4"]
-build-backend = "jupyter_packaging.build_api"
+build-backend = "hatchling.build"
+requires = ["hatchling>=1.4.0", "hatch-nodejs-version", "jupyterlab~=3.4"]
 
-[tool.jupyter-packaging.options]
-skip-if-exists = ["jupyterlab_blockly/labextension/static/style.js"]
-ensured-targets = ["jupyterlab_blockly/labextension/static/style.js", "jupyterlab_blockly/labextension/package.json"]
+[project]
+name = "jupyterlab_blockly"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.7"
+classifiers = [
+    "Framework :: Jupyter",
+    "Framework :: Jupyter :: JupyterLab",
+    "Framework :: Jupyter :: JupyterLab :: 3",
+    "Framework :: Jupyter :: JupyterLab :: Extensions",
+    "Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+	"jupyterlab~=3.4"
+]
+dynamic = ["version", "description", "authors", "urls", "keywords"]
+
+[project.optional-dependencies]
+dev = [
+    "click",
+    "jupyter_releaser==0.22"
+]
+
+[tool.hatch.version]
+source = "nodejs"
+
+[tool.hatch.metadata.hooks.nodejs]
+fields = ["description", "authors", "urls"]
 
-[tool.jupyter-packaging.builder]
-factory = "jupyter_packaging.npm_builder"
+[tool.hatch.build]
+artifacts = ["package.json", "scripts", "packages", "patches", "jupyterlab_blockly/labextension"]
+exclude = [".github", "binder"]
+
+[tool.hatch.build.targets.wheel.shared-data]
+"jupyterlab_blockly/labextension" = "share/jupyter/labextensions/jupyterlab-blockly-extension"
+"install.json" = "share/jupyter/labextensions/jupyterlab-blockly-extension/install.json"
+
+[tool.hatch.build.hooks.jupyter-builder]
+dependencies = ["hatch-jupyter-builder>=0.5"]
+build-function = "hatch_jupyter_builder.npm_builder"
+ensured-targets = [
+    "jupyterlab_blockly/labextension/static/style.js",
+    "jupyterlab_blockly/labextension/package.json",
+]
+skip-if-exists = ["jupyterlab_blockly/labextension/static/style.js"]
 
-[tool.jupyter-packaging.build-args]
+[tool.hatch.build.hooks.jupyter-builder.build-kwargs]
 build_cmd = "build:prod"
 npm = ["jlpm"]
 
-[tool.check-manifest]
-ignore = ["jupyterlab_blockly/labextension/**", "packages/**", "assets/**", "lerna.json", "yarn.lock", ".*", "package-lock.json", "docs/**"]
-
-[tool.jupyter-releaser.hooks]
-before-bump-version = ["python -m pip install jupyterlab~=3.4"]
-before-build-npm = ["python -m pip install jupyterlab", "jlpm"]
+[tool.hatch.build.hooks.jupyter-builder.editable-build-kwargs]
+build_cmd = "install:extension"
+npm = ["jlpm"]
+build_dir = "jupyterlab_blockly/labextension"
 
 [tool.jupyter-releaser.options]
 version-cmd = "python scripts/bump-version.py --force"
+
+[tool.jupyter-releaser.hooks]
+before-bump-version = ["python -m pip install jupyterlab~=3.4", "jlpm"]
+before-build-npm = ["python -m pip install jupyterlab~=3.4", "jlpm", "jlpm build:prod"]
+before-build-python = ["jlpm clean:all"]
+
+[tool.check-wheel-contents]
+ignore = ["W002"]

pyproject.toml

@@ -7,6 +7,9 @@
 # The full license is in the file LICENSE, distributed with this software.  #
 #############################################################################
 
+import json
+from pathlib import Path
+
 import click
 from jupyter_releaser.util import get_version, run
 from pkg_resources import parse_version
@@ -54,6 +57,20 @@ def bump(force, spec):
         lerna_cmd += " --yes"
     run(lerna_cmd)
 
+    HERE = Path(__file__).parent.parent.resolve()
+    path = HERE.joinpath("package.json")
+    if path.exists():
+        with path.open(mode="r") as f:
+            data = json.load(f)
+
+        data["version"] = js_version
+
+        with path.open(mode="w") as f:
+            json.dump(data, f, indent=2)
+
+    else:
+        raise FileNotFoundError(f"Could not find package.json under dir {path!s}")
+
 
 if __name__ == "__main__":
     bump()

scripts/bump-version.py

@@ -1,97 +1,2 @@
-"""
-jupyterlab_blockly setup
-"""
-import json
-import sys
-from pathlib import Path
-
-import setuptools
-
-HERE = Path(__file__).parent.resolve()
-
-# The name of the project
-name = "jupyterlab_blockly"
-
-lab_path = (HERE / name.replace("-", "_") / "labextension")
-
-# Representative files that should exist after a successful build
-ensured_targets = [
-    str(lab_path / "package.json"),
-    str(lab_path / "static/style.js")
-]
-
-labext_name = "jupyterlab-blockly-extension"
-
-data_files_spec = [
-    ("share/jupyter/labextensions/%s" % labext_name, str(lab_path.relative_to(HERE)), "**"),
-    ("share/jupyter/labextensions/%s" % labext_name, str("."), "install.json"),
-]
-
-long_description = (HERE / "README.md").read_text()
-
-# Get the package info from package.json
-pkg_json = json.loads((HERE / "packages/blockly-extension/package.json").read_bytes())
-version = (
-    pkg_json["version"]
-    .replace("-alpha.", "a")
-    .replace("-beta.", "b")
-    .replace("-rc.", "rc")
-) 
-
-setup_args = dict(
-    name=name,
-    version=version,
-    url=pkg_json["homepage"],
-    author=pkg_json["author"]["name"],
-    author_email=pkg_json["author"]["email"],
-    description=pkg_json["description"],
-    license=pkg_json["license"],
-    license_file="LICENSE",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    packages=setuptools.find_packages(),
-    install_requires=[],
-    extras_require={
-        'dev': ['click','jupyter_releaser==0.22']
-    },
-    zip_safe=False,
-    include_package_data=True,
-    python_requires=">=3.7",
-    platforms="Linux, Mac OS X, Windows",
-    keywords=["Jupyter", "JupyterLab", "JupyterLab3"],
-    classifiers=[
-        "License :: OSI Approved :: BSD License",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Framework :: Jupyter",
-        "Framework :: Jupyter :: JupyterLab",
-        "Framework :: Jupyter :: JupyterLab :: 3",
-        "Framework :: Jupyter :: JupyterLab :: Extensions",
-        "Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt",
-    ],
-)
-
-try:
-    from jupyter_packaging import (
-        wrap_installers,
-        npm_builder,
-        get_data_files
-    )
-    post_develop = npm_builder(
-        build_cmd="install:extension", source_dir="src", build_dir=lab_path,  npm='jlpm'
-    )
-    setup_args["cmdclass"] = wrap_installers(post_develop=post_develop, ensured_targets=ensured_targets)
-    setup_args["data_files"] = get_data_files(data_files_spec)
-except ImportError as e:
-    import logging
-    logging.basicConfig(format="%(levelname)s: %(message)s")
-    logging.warning("Build tool `jupyter-packaging` is missing. Install it with pip or conda.")
-    if not ("--name" in sys.argv or "--version" in sys.argv):
-        raise e
-
-if __name__ == "__main__":
-    setuptools.setup(**setup_args)
+# setup.py shim for use with applications that require it.
+__import__('setuptools').setup()