From 99bf829f2df1344d6ce12f2f4d6c723f2c84aeee Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 14:25:57 +0530 Subject: [PATCH 01/11] update contributing.md accordingly as contributing.rst --- CONTRIBUTING.md | 117 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 95 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b02e61488..6f0f2bb25 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,53 +1,126 @@ -## Contributing +# Contributing -### Development install +## Development Install -**Note:** You will need [Node.js](https://nodejs.org/) to build the extension package. +> **Note** +> You will need [Node.js](https://nodejs.org/) 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](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) in lieu of `jlpm` below. -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. +### Clone the Source ```bash # Clone the repo to your local environment git clone https://github.com/geojupyter/jupytergis.git + # Change directory to the jupytergis directory cd jupytergis -# Install package in development mode +``` + +### Create a Virtual Environment + +#### Micromamba (Recommended) + +```bash +# Create a virtual environment +micromamba create --name jupytergis_dev -c conda-forge pip "nodejs<22" qgis + +# Activate it +micromamba activate jupytergis_dev +``` + +#### Plain Python + +> **Note** +> You may need to install some non-Python dependencies (e.g., QGIS, Node.js) separately when using this method. + +```bash +# Create a virtual environment +python -m venv .venv + +# Activate it +source .venv/bin/activate +``` + +### Install Dependencies and Build + +```bash +# Install packages in development mode. +# WARNING: This step may hang indefinitely due to a bug in Nx. See troubleshooting below. python scripts/dev-install.py + +# Rebuild extension Typescript source after making changes +jlpm run build +``` + +> **Note** +> 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 ``` +### Watch for Changes and Rebuild + 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 -# Alternatively, you can run the following after each TypeScript code change -jlpm run build:dev - # 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). +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: +> **Note** +> `jlpm run watch` will sit and wait for a change once started. Edit a file to trigger a build. -```bash -jupyter lab build --minimize=False -``` - -### Development uninstall +## Development Uninstall ```bash pip uninstall jupytergis ``` -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 `jupytergis` within that folder. +In development mode, you will also need to remove the symlink created by the `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 `jupytergis` within that folder. + +## Code Quality + +We have several tools configured for checking code quality: + +- **Pre-commit checks** run automatically at commit time. + Install checks with: + + ```bash + pre-commit install + ``` + + Run them manually with: + + ```bash + pre-commit run --all-files + ``` + + - `Ruff` formats and lints (sometimes autofixes) Python code. + - Generic pre-commit checks help avoid common mistakes like committing large files or trailing whitespace. + +- **Package scripts** (defined in `package.json`) to check (and/or fix) TypeScript, JavaScript, CSS, JSON, Markdown, and YAML. + Run manually with: + + ```bash + jlpm run lint + ``` + + - `Prettier` formats the file types listed above. + - `Eslint` lints (sometimes autofixes) JS/TS code. + +## Troubleshooting -### Packaging the extension +- **Setup of development environment hangs indefinitely** when running the `dev-install.py` step, specifically on the Yarn linking step. -See [RELEASE](RELEASE.md) + - This may be caused by having a `.gitignore` file in your home directory. + This is a [known issue with Nx](https://github.com/nrwl/nx/issues/27494). + The [only known workaround](https://github.com/nrwl/nx/issues/27494#issuecomment-2481207598) is to remove the `.gitignore` file from your home directory or to work in a location outside of the home directory tree. From 69673257331697931691ea31a0c45962e8b695c6 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 14:52:39 +0530 Subject: [PATCH 02/11] try using myst-parser to parse md --- docs/contributing.rst | 153 +------------------------------------- docs/environment-docs.yml | 1 + 2 files changed, 3 insertions(+), 151 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index d382b5ce5..9b3b21c9b 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,151 +1,2 @@ -============ -Contributing -============ - -Development install -------------------- - -.. note:: - - You will need `Node.js `_ to build the extension package. - - The ``jlpm`` command is JupyterLab's pinned version of - `yarn `__ that is installed with JupyterLab. You may use - `yarn `__ or `npm `_ in lieu of ``jlpm`` below. - - -Clone the source -^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - # Clone the repo to your local environment - git clone https://github.com/geojupyter/jupytergis.git - - # Change directory to the jupytergis directory - cd jupytergis - - -Create a virtual environment -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. tabs:: - - .. tab:: Micromamba (recommended) - - .. code-block:: bash - - # Create a virtual environment - micromamba create --name jupytergis_dev -c conda-forge pip "nodejs<22" qgis - - # Activate it - micromamba activate jupytergis_dev - - - .. tab:: Plain python - - .. note:: - - You may need to install some non-Python dependencies (e.g. QGIS, - Node.js) separately when using this method. - - - .. code-block:: bash - - # Create a virtual environment - python -m venv .venv - - # Activate it - source .venv/bin/activate - - -Install dependencies and build -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code-block:: bash - - # Install packages in development mode. - # WARNING: This step may hang indefinitely due to a bug in Nx. See - # troubleshooting below. - python scripts/dev-install.py - - # Rebuild extension Typescript source after making changes - jlpm run build - - -.. note:: - - 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: - - .. code-block:: bash - - jupyter lab build --minimize=False - - -Watch for changes and rebuild -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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 - - # 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). - -.. note:: - - ``jlpm run watch`` will sit and wait for a change once started. Edit a file - to trigger a build. - - -Development uninstall ----------------------- - -.. code-block:: bash - - pip uninstall jupytergis - -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 ``jupytergis`` within that folder. - - -Code quality ------------- - -We have several tools configured for checking code quality: - -* Pre-commit checks run automatically at commit time. - Install checks with ``pre-commit install``. - Run them manually with ``pre-commit run --all-files``. - **Will exit non-zero when finding errors or changing files.** - - * Ruff formats and lints (sometimes autofixes) Python code. - - * Generic pre-commit checks help avoid common mistakes like committing large - files or trailing whitespace. - -* Package scripts (defined in ``package.json``) to check (and/or fix) - TypeScript, JavaScript, CSS, JSON, Markdown, and YAML. - Run manually with ``jlpm run lint``. - **Will exit 0 when applying fixes. - Check the logs and/or ``git status`` after every run.** - - * Prettier formats the file types listed above. - - * Eslint lints (sometimes autofixes) JS/TS code. - - -Troubleshooting ---------------- - -* Setup of development environment hangs indefinitely when running the - ``dev-install.py`` step, specifically on the Yarn linking step. - - * This may be caused by having a ``.gitignore`` file in your home directory. - This is a `known issue with Nx `_. - The `only known workaround `_ is to remove the ``.gitignore`` file from your home directory or to work in a location outside of the home directory tree. +.. include:: contributing.md + :parser: myst_parser diff --git a/docs/environment-docs.yml b/docs/environment-docs.yml index 9d084690f..eb8dc64c1 100644 --- a/docs/environment-docs.yml +++ b/docs/environment-docs.yml @@ -14,5 +14,6 @@ dependencies: - sphinx-tabs - pydata-sphinx-theme - sphinx-autodoc-typehints + - myst_parser - xeus-python # TODO: Do we need this? From b72ad20d1773a71e0bacef0f24c3c56d6ee4b50e Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 15:02:52 +0530 Subject: [PATCH 03/11] Install myst-parser via pip --- CONTRIBUTING.md | 28 ++++++++++++++-------------- docs/environment-docs.yml | 4 ++++ 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f0f2bb25..eae794433 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,9 @@ ## Development Install -> **Note** -> You will need [Node.js](https://nodejs.org/) to build the extension package. -> The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab. +> **Note** +> You will need [Node.js](https://nodejs.org/) 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](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) in lieu of `jlpm` below. ### Clone the Source @@ -31,7 +31,7 @@ micromamba activate jupytergis_dev #### Plain Python -> **Note** +> **Note** > You may need to install some non-Python dependencies (e.g., QGIS, Node.js) separately when using this method. ```bash @@ -53,8 +53,8 @@ python scripts/dev-install.py jlpm run build ``` -> **Note** -> 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. +> **Note** +> 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 @@ -75,7 +75,7 @@ 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). -> **Note** +> **Note** > `jlpm run watch` will sit and wait for a change once started. Edit a file to trigger a build. ## Development Uninstall @@ -84,14 +84,14 @@ With the `watch` command running, every saved change will immediately be built l pip uninstall jupytergis ``` -In development mode, you will also need to remove the symlink created by the `jupyter labextension develop` command. +In development mode, you will also need to remove the symlink created by the `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 `jupytergis` within that folder. ## Code Quality We have several tools configured for checking code quality: -- **Pre-commit checks** run automatically at commit time. +- **Pre-commit checks** run automatically at commit time. Install checks with: ```bash @@ -104,23 +104,23 @@ We have several tools configured for checking code quality: pre-commit run --all-files ``` - - `Ruff` formats and lints (sometimes autofixes) Python code. + - `Ruff` formats and lints (sometimes autofixes) Python code. - Generic pre-commit checks help avoid common mistakes like committing large files or trailing whitespace. -- **Package scripts** (defined in `package.json`) to check (and/or fix) TypeScript, JavaScript, CSS, JSON, Markdown, and YAML. +- **Package scripts** (defined in `package.json`) to check (and/or fix) TypeScript, JavaScript, CSS, JSON, Markdown, and YAML. Run manually with: ```bash jlpm run lint ``` - - `Prettier` formats the file types listed above. + - `Prettier` formats the file types listed above. - `Eslint` lints (sometimes autofixes) JS/TS code. ## Troubleshooting - **Setup of development environment hangs indefinitely** when running the `dev-install.py` step, specifically on the Yarn linking step. - - This may be caused by having a `.gitignore` file in your home directory. - This is a [known issue with Nx](https://github.com/nrwl/nx/issues/27494). + - This may be caused by having a `.gitignore` file in your home directory. + This is a [known issue with Nx](https://github.com/nrwl/nx/issues/27494). The [only known workaround](https://github.com/nrwl/nx/issues/27494#issuecomment-2481207598) is to remove the `.gitignore` file from your home directory or to work in a location outside of the home directory tree. diff --git a/docs/environment-docs.yml b/docs/environment-docs.yml index eb8dc64c1..25167b502 100644 --- a/docs/environment-docs.yml +++ b/docs/environment-docs.yml @@ -17,3 +17,7 @@ dependencies: - myst_parser - xeus-python # TODO: Do we need this? + + # Install myst-parser via pip + - pip: + - myst-parser From 5e81bc5b3bb600d53d6d43d5088245d297c150f4 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 15:46:21 +0530 Subject: [PATCH 04/11] typo --- docs/conf.py | 1 + docs/environment-docs.yml | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8d52b40e4..f183ce9bb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx_tabs.tabs", + "myst_parser", ] source_suffix = ".rst" diff --git a/docs/environment-docs.yml b/docs/environment-docs.yml index 25167b502..170008ad7 100644 --- a/docs/environment-docs.yml +++ b/docs/environment-docs.yml @@ -14,7 +14,6 @@ dependencies: - sphinx-tabs - pydata-sphinx-theme - sphinx-autodoc-typehints - - myst_parser - xeus-python # TODO: Do we need this? From 1378a11aac394808c270e39903f8fb79c967268c Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 16:05:49 +0530 Subject: [PATCH 05/11] pin myst-parser --- docs/environment-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/environment-docs.yml b/docs/environment-docs.yml index 170008ad7..7cbcf2842 100644 --- a/docs/environment-docs.yml +++ b/docs/environment-docs.yml @@ -19,4 +19,4 @@ dependencies: # Install myst-parser via pip - pip: - - myst-parser + - myst-parser<4.0.0 From 72ae3c0a0b412a455cb726bbb92398dd1fb45442 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 16:15:58 +0530 Subject: [PATCH 06/11] try building RTD --- docs/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 9b3b21c9b..6889b7c46 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,2 +1,2 @@ -.. include:: contributing.md - :parser: myst_parser +.. include:: ../CONTRIBUTING.md + :parser: myst_parser.sphinx_ From 90153e425955d5cda3c87591d62a779f30253f3a Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 18:03:10 +0530 Subject: [PATCH 07/11] lint --- CONTRIBUTING.md | 3 +-- docs/environment-docs.yml | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eae794433..e8bdd47b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,8 +75,7 @@ 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). -> **Note** -> `jlpm run watch` will sit and wait for a change once started. Edit a file to trigger a build. +> **Note** > `jlpm run watch` will sit and wait for a change once started. Edit a file to trigger a build. ## Development Uninstall diff --git a/docs/environment-docs.yml b/docs/environment-docs.yml index 7cbcf2842..a9d0fcc3b 100644 --- a/docs/environment-docs.yml +++ b/docs/environment-docs.yml @@ -19,4 +19,4 @@ dependencies: # Install myst-parser via pip - pip: - - myst-parser<4.0.0 + - myst-parser<4.0.0 From df269921adeeecb57a9dff57b95471ac34c3c7b7 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 18:45:35 +0530 Subject: [PATCH 08/11] pass pre-commit --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 17f830cd3..e3dc8a543 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -37,4 +37,4 @@ repos: rev: v6.2.4 hooks: - id: rstcheck - args: ['--ignore-directives=tabs,toctree,autoclass,cssclass', '--report-level=warning'] + args: ['--ignore-directives=tabs,toctree,autoclass,cssclass,include', '--report-level=warning'] From e9b6928de262a5d79d949f41e0ffab471d767b56 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 18:57:02 +0530 Subject: [PATCH 09/11] fic CI --- .github/workflows/build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a70311a1d..8f7dc5229 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -275,6 +275,7 @@ jobs: sphinx-tabs pydata-sphinx-theme sphinx-autodoc-typehints + myst-parser<4.0.0 - name: Download extension package uses: actions/download-artifact@v4 From 71ee66be719b94ac462e4cf7f45fc1d5e9cba5d7 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 20:52:04 +0530 Subject: [PATCH 10/11] Add changelog to docs too --- docs/changelog.rst | 2 ++ docs/contributing.rst | 2 +- docs/index.rst | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 docs/changelog.rst diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 000000000..0e7f899fa --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,2 @@ +.. include:: ../CHANGELOG.md + :parser: myst_parser diff --git a/docs/contributing.rst b/docs/contributing.rst index 6889b7c46..7306780e8 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,2 +1,2 @@ .. include:: ../CONTRIBUTING.md - :parser: myst_parser.sphinx_ + :parser: myst_parser diff --git a/docs/index.rst b/docs/index.rst index 855c04c33..49e233610 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,3 +37,4 @@ Table of contents python_api collab.rst contributing.rst + changelog.rst From 9374d451a469b149e9301da6ef9051247ca53aa3 Mon Sep 17 00:00:00 2001 From: arjxn-py Date: Wed, 22 Jan 2025 20:59:56 +0530 Subject: [PATCH 11/11] fix rtd build --- docs/changelog.rst | 2 +- docs/contributing.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 0e7f899fa..4afc7d3ff 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,2 +1,2 @@ .. include:: ../CHANGELOG.md - :parser: myst_parser + :parser: myst_parser.sphinx_ diff --git a/docs/contributing.rst b/docs/contributing.rst index 7306780e8..6889b7c46 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,2 +1,2 @@ .. include:: ../CONTRIBUTING.md - :parser: myst_parser + :parser: myst_parser.sphinx_