[pydeck] Create a prebuilt extension for JupyterLab

bindings/pydeck/MANIFEST.in

@@ -1,9 +1,15 @@
 include LICENSE.txt
-include README.md
+include *.md
+include pyproject.toml
 
 include pytest.ini
 include .coveragerc
 
+include package.json
+include install.json
+include ts*.json
+include yarn.lock
+
 include pydeck/io/templates/*.j2
 
 # Examples
@@ -13,10 +19,16 @@ graft examples
 graft tests
 prune tests/build
 
-# Javascript files
 graft pydeck/nbextension
+graft pydeck/labextension
 prune setup
 
+# Javascript files
+graft src
+graft style
+prune **/node_modules
+prune lib
+
 # Patterns to exclude from any directory
 global-exclude *~
 global-exclude *.pyc

bindings/pydeck/RELEASE.md

@@ -0,0 +1,61 @@
+# Making a new release of pydeck
+
+The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+## Manual release
+
+### Python package
+
+This extension can be distributed as Python
+packages. All of the Python
+packaging instructions in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, we first need to install `build`.
+
+```bash
+pip install build twine
+```
+
+To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
+
+```bash
+python -m build
+```
+
+> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
+
+Then to upload the package to PyPI, do:
+
+```bash
+twine upload dist/*
+```
+
+### NPM package
+
+To publish the frontend part of the extension as a NPM package, do:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser.
+
+Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
+
+Here is a summary of the steps to cut a new release:
+
+- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
+- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
+- Go to the Actions panel
+- Run the "Draft Changelog" workflow
+- Merge the Changelog PR
+- Run the "Draft Release" workflow
+- Run the "Publish Release" workflow
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

bindings/pydeck/package.json

@@ -0,0 +1 @@
+../../modules/jupyter-widget/package.json

bindings/pydeck/pydeck/_version.py

@@ -1 +1 @@
-__version__ = "0.7.1"
+__version__ = "0.8.0"

bindings/pydeck/pydeck/frontend_semver.py

@@ -1 +1 @@
-DECKGL_SEMVER = "~8.5.*"
+DECKGL_SEMVER = "8.7.*"

bindings/pydeck/pyproject.toml

@@ -1,34 +1,24 @@
 [project]
 name = "pydeck"
-version = "0.7.1"
+version = "0.8.0"
 requires-python = ">=3.7"
 
 [build-system]
-requires = [
-  "setuptools",
-  "wheel",
-]
+requires = ["jupyter_packaging~=0.10,<2", "jupyterlab~=3.1"]
+build-backend = "jupyter_packaging.build_api"
 
-[tool.black]
-line-length = 120
-target-version = ['py34']
-include = '\.pyi?$'
-exclude = '''
+[tool.jupyter-packaging.options]
+skip-if-exists = ["pydeck/labextension/static/style.js"]
+ensured-targets = ["pydeck/labextension/static/style.js", "pydeck/labextension/package.json"]
 
-(
-  /(
-      \.eggs         # exclude a few common directories in the
-    | \.git          # root of the project
-    | \.hg
-    | \.mypy_cache
-    | \.tox
-    | \.venv
-    | _build
-    | buck-out
-    | build
-    | dist
-  )/
-  | foo.py           # also separately exclude a file named foo.py in
-                     # the root of the project
-)
-'''
+[tool.jupyter-packaging.builder]
+factory = "jupyter_packaging.npm_builder"
+
+[tool.jupyter-packaging.build-args]
+build_cmd = "build:labextension"
+path = "../../modules/jupyter-widget"
+build_dir = "pydeck/labextension"
+npm = ["jlpm"]
+
+[tool.check-manifest]
+ignore = ["pydeck/labextension/**", "yarn.lock", ".*", "package-lock.json"]