From a9f36dc0a85adf92bac43603618f245f65a1ba0e Mon Sep 17 00:00:00 2001 From: Florence Haudin Date: Tue, 6 May 2025 17:09:52 +0200 Subject: [PATCH 1/3] Update development installation instructions in contributing.rst. --- docs/source/contributing.rst | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index b2f6c8baf..33e759440 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -7,11 +7,14 @@ Contributing Development install ------------------- -**Note:** You will need :ref:`Node.js ` and :ref:`Docker ` to build the extension package. +You need to create a development environment with `nodejs` and `jupyterlab` installed. We are here proposing to use `micromamba`. -The ``jlpm`` command is JupyterLab's pinned version of -:ref:`yarn ` that is installed with JupyterLab. You may use -:ref:`yarn ` or :ref:`npm ` in lieu of ``jlpm`` below. +.. code-block:: bash + + # Create an environment with micromamba and install nodejs and jupyterlab + micromamba create -n jupytercad_dev -c conda-forge nodejs jupyterlab -y + +You then need to clone the repository, proceed to installation and rebuild the extension. .. code-block:: bash @@ -19,13 +22,24 @@ The ``jlpm`` command is JupyterLab's pinned version of git clone https://github.com/jupytercad/JupyterCAD.git # Change directory to the jupytercad directory cd JupyterCAD - # Install JupyterLab for jlpm - pip install jupyterlab - # Install package in development mode - python scripts/dev-install.py + # Install dependencies and the package in development mode + jlpm install + jlpm dev ## if you haven't Docker installed replace this line by `jlpm dev --no-occ-build` # Rebuild extension Typescript source after making changes jlpm run build +**Note:** There are 2 possibilities for the installation. + +1) either you are using [Docker](https://www.docker.com/) to build `@jupytercad/opencascade` package and you need to run `jlpm dev` in the commands above. + +2) or you are using a prebuilt version by calling `jlpm dev --no-occ-build` to install the package. + + +**Note:** The `jlpm` command is JupyterLab's pinned version of +[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use +`yarn` or `npm` in lieu of `jlpm` above. + + You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. .. code-block:: bash From 5287368d6002b15d1dc5543966c56c938addda3a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 6 May 2025 15:26:14 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 33e759440..a216a8d5c 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -28,7 +28,7 @@ You then need to clone the repository, proceed to installation and rebuild the e # Rebuild extension Typescript source after making changes jlpm run build -**Note:** There are 2 possibilities for the installation. +**Note:** There are 2 possibilities for the installation. 1) either you are using [Docker](https://www.docker.com/) to build `@jupytercad/opencascade` package and you need to run `jlpm dev` in the commands above. From 194ef5b6ad34c39ef426d83ed6a39c7c1d05ee10 Mon Sep 17 00:00:00 2001 From: Florence Haudin Date: Tue, 6 May 2025 17:30:10 +0200 Subject: [PATCH 3/3] Update CONTRIBUTING.md by replacing the previous content by a link. --- CONTRIBUTING.md | 86 +------------------------------------------------ 1 file changed, 1 insertion(+), 85 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a74c0e839..0fe88bd02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,85 +1 @@ -## Contributing - -### Development install - -**Note:** You will need [Node.js](https://nodejs.org/) and [Docker](https://www.docker.com/) to build the extension package. - -The `jlpm` command is JupyterLab's pinned version of -[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use -`yarn` or `npm` in lieu of `jlpm` below. - -```bash -# Clone the repo to your local environment -git clone https://github.com/jupytercad/JupyterCAD.git -# Change directory to the jupytercad directory -cd JupyterCAD -# Install JupyterLab for jlpm -pip install jupyterlab -# Install package in development mode -jlpm dev -# Rebuild extension Typescript source after making changes -jlpm run build -``` - -**Note:** You need to have docker installed to build `@jupytercad/opencascade` package, you can skip this step and download a prebuilt version by calling `jlpm dev --no-occ-build` instead of `jlpm dev`. - -You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. - -```bash -# Watch the source directory in one terminal, automatically rebuilding when needed -jlpm run watch -# Run JupyterLab in another terminal -jupyter lab -``` - -With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt). - -By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command: - -```bash -jupyter lab build --minimize=False -``` - -### Custom Open Cascade WASM build - -JupyterCAD uses a custom build of Open Cascade WASM. For performance and data usage concern, we only build the symbols we need. - -This custom build is done in the `packages/opencascade` directory: - -```bash -cd packages/opencascade -``` - -In order to rebuild it yourself, you need to install Docker, then you need to run the following (this may take some time): - -```bash -yarn run build -``` - -In the case where you need to add new symbols, you can rebuild Open Cascade with the following command. - -```bash -yarn run build --add symbol_to_add another_symbol ... -``` - -#### See also - -Custom build doc: https://ocjs.org/docs/app-dev-workflow/custom-builds - -Custom build example: https://github.com/donalffons/opencascade.js/blob/master/website/ocjs-editor-theme/src/customBuild/customBuild.yml - -Where to find symbols: https://dev.opencascade.org/doc/refman/html/annotated.html - -### Development uninstall - -```bash -pip uninstall jupytercad -``` - -In development mode, you will also need to remove the symlink created by `jupyter labextension develop` -command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions` -folder is located. Then you can remove the symlink named `jupytercad` within that folder. - -### Packaging the extension - -See [RELEASE](RELEASE.md) +Please check out [our documentation's contributing guide](https://jupytercad.readthedocs.io/en/latest/contributing.html).