Jupyterlab v4

.copier-answers.yml

@@ -0,0 +1,13 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.3.5
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: [email protected]
+author_name: CS Group
+has_binder: false
+has_settings: true
+kind: server
+labextension_name: eodag-labextension
+project_short_description: Searching remote sensed imagery from various image providers
+python_name: eodag_labextension
+repository: https://github.com/CS-SI/eodag-labextension.git
+test: false

.github/workflows/build.yml

@@ -28,38 +28,27 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Install node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: '18.x'
+          cache: 'yarn'
       - name: Install Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.9'
           architecture: 'x64'
 
       - name: Setup pip cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: pip-3.9-${{ hashFiles('package.json') }}
           restore-keys: |
             pip-3.9-
             pip-
 
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-      - name: Setup yarn cache
-        uses: actions/cache@v2
-        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            yarn-
-
       - name: Install dependencies
-        run: python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.7.9
+        run: python -m pip install -U jupyterlab~=4.0 jupyter_packaging~=0.7.9
       - name: Build the extension
         run: |
           jlpm

.gitignore

@@ -1,10 +1,15 @@
 *.bundle.*
 lib/
 node_modules/
+*.log
+.eslintcache
+.stylelintcache
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
 eodag_labextension/labextension
+# Version file is handled by hatchling
+eodag_labextension/_version.py
 
 # Created by https://www.gitignore.io/api/python
 # Edit at https://www.gitignore.io/?templates=python
@@ -56,6 +61,7 @@ htmlcov/
 .coverage.*
 .cache
 nosetests.xml
+coverage/
 coverage.xml
 *.cover
 .hypothesis/
@@ -111,6 +117,10 @@ dmypy.json
 # OSX files
 .DS_Store
 
+# Yarn cache
+.yarn/
+
 # IDE
-.idea
-.vscode
+.idea/
+
+.venv/

.pre-commit-config.yaml

@@ -38,6 +38,8 @@ repos:
     rev: v8.24.0
     hooks:
       - id: eslint
+        language: node
+        language_version: '22.11.0'
         additional_dependencies:
           - [email protected]
           - [email protected]
@@ -51,8 +53,12 @@ repos:
     rev: v2.7.1
     hooks:
       - id: prettier
+        language: node
+        language_version: '22.11.0'
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.32.2
     hooks:
       - id: markdownlint
+        language: node
+        language_version: '22.11.0'

.prettierignore

@@ -2,4 +2,5 @@ node_modules
 **/node_modules
 **/lib
 **/package.json
-eodag-labextension
+!/package.json
+eodag_labextension

.yarnrc.yml

@@ -0,0 +1,6 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+enableImmutableInstalls: false
+nodeLinker: node-modules

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

RELEASE.md

@@ -0,0 +1,80 @@
+# Making a new release of eodag_labextension
+
+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 are in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, you first need to install some tools:
+
+```bash
+pip install build twine hatch
+```
+
+Bump the version using `hatch`. By default this will create a tag.
+See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
+
+```bash
+hatch version <new-version>
+```
+
+Make sure to clean up all the development files before building the package:
+
+```bash
+jlpm clean:all
+```
+
+You could also clean up the local git repository:
+
+```bash
+git clean -dfX
+```
+
+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. But
+the GitHub repository and the package managers need to be properly set up. Please
+follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
+
+Here is a summary of the steps to cut a new release:
+
+- Go to the Actions panel
+- Run the "Step 1: Prep Release" workflow
+- Check the draft changelog
+- Run the "Step 2: Publish Release" workflow
+
+> [!NOTE]
+> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
+> for more information.
+
+## 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.

jupyter-config/server-config/eodag_labextension.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "eodag_labextension": true
+    }
+  }
+}