jupyter-builder 0.1.0a2__tar.gz → 0.1.0a4__tar.gz

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/.licenserc.yaml

@@ -20,5 +20,6 @@ header:
     - node_modules/**
     - node_modules/.**
     - 'yarn.lock'
+    - 'jupyter_builder/yarn.js'
 
   comment: on-failure

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/.pre-commit-config.yaml

@@ -20,6 +20,7 @@ repos:
       - id: end-of-file-fixer
         exclude: \.copier-answers\.yml
       - id: trailing-whitespace
+        exclude: yarn.js
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.27.4
@@ -38,7 +39,7 @@ repos:
     hooks:
       - id: codespell
         args: ["-L", "sur,nd"]
-        exclude: jupyter_builder/yarn.js
+        exclude: "jupyter_builder/yarn.js|jupyter_builder/jupyterlab_semver.py"
 
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: "v1.10.0"
@@ -57,11 +58,11 @@ repos:
           ["traitlets>=5.13"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.4
+    rev: v0.9.4
     hooks:
-      # - id: ruff
-      #   types_or: [python, jupyter]
-      #   args: ["--fix", "--show-fixes"]
+      - id: ruff
+        types_or: [python, jupyter]
+        args: ["--fix", "--show-fixes"]
       - id: ruff-format
         types_or: [python, jupyter]
 

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/.prettierignore

@@ -4,3 +4,5 @@ node_modules
 **/package.json
 !/package.json
 jupyter_builder
+*.md
+jupyter_builder/yarn.js

jupyter_builder-0.1.0a4/CHANGELOG.md

@@ -0,0 +1,89 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+## 0.1.0a4
+
+([Full Changelog](https://github.com/jupyterlab/jupyter-builder/compare/v0.1.0a3...2e9b6382798d488315617750333cc50f5a445b5c))
+
+### Enhancements made
+
+- Sync `yarn.js` with core [#47](https://github.com/jupyterlab/jupyter-builder/pull/47) ([@Darshan808](https://github.com/Darshan808), [@krassowski](https://github.com/krassowski))
+- Add `jupyterlab_server` and update some dependencies [#44](https://github.com/jupyterlab/jupyter-builder/pull/44) ([@Darshan808](https://github.com/Darshan808), [@krassowski](https://github.com/krassowski))
+- Migrated Builder Folder to jupyter-builder [#29](https://github.com/jupyterlab/jupyter-builder/pull/29) ([@Darshan808](https://github.com/Darshan808), [@fcollonval](https://github.com/fcollonval), [@jtpio](https://github.com/jtpio))
+
+### Maintenance and upkeep improvements
+
+- Bump the actions group across 1 directory with 6 updates [#39](https://github.com/jupyterlab/jupyter-builder/pull/39) ([@krassowski](https://github.com/krassowski))
+- Bump ruff from 0.9.9 to 0.11.2 in the pip group [#36](https://github.com/jupyterlab/jupyter-builder/pull/36) ([@krassowski](https://github.com/krassowski))
+- Bump ruff from 0.9.4 to 0.9.9 in the pip group [#35](https://github.com/jupyterlab/jupyter-builder/pull/35) ([@fcollonval](https://github.com/fcollonval))
+- Bump apache/skywalking-eyes from 0.6.0 to 0.7.0 in the actions group [#34](https://github.com/jupyterlab/jupyter-builder/pull/34) ([@fcollonval](https://github.com/fcollonval))
+- Bump ruff from 0.8.4 to 0.9.4 in the pip group [#33](https://github.com/jupyterlab/jupyter-builder/pull/33) ([@jtpio](https://github.com/jtpio))
+- Bump ruff from 0.8.1 to 0.8.4 in the pip group [#32](https://github.com/jupyterlab/jupyter-builder/pull/32) ([@fcollonval](https://github.com/fcollonval))
+- Bump ruff from 0.7.1 to 0.8.1 in the pip group [#31](https://github.com/jupyterlab/jupyter-builder/pull/31) ([@jtpio](https://github.com/jtpio))
+- Bump ruff from 0.6.8 to 0.7.1 in the pip group [#30](https://github.com/jupyterlab/jupyter-builder/pull/30) ([@fcollonval](https://github.com/fcollonval))
+- Bump ruff from 0.5.5 to 0.6.8 in the pip group across 1 directory [#28](https://github.com/jupyterlab/jupyter-builder/pull/28) ([@fcollonval](https://github.com/fcollonval))
+
+### Documentation improvements
+
+- Update README.md 2 [#26](https://github.com/jupyterlab/jupyter-builder/pull/26) ([@cronan03](https://github.com/cronan03), [@fcollonval](https://github.com/fcollonval))
+
+### Contributors to this release
+
+The following people contributed discussions, new ideas, code and documentation contributions, and review.
+See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/use/#how-does-this-tool-define-contributions-in-the-reports).
+
+([GitHub contributors page for this release](https://github.com/jupyterlab/jupyter-builder/graphs/contributors?from=2024-07-30&to=2026-02-05&type=c))
+
+@cronan03 ([activity](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Acronan03+updated%3A2024-07-30..2026-02-05&type=Issues)) | @Darshan808 ([activity](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3ADarshan808+updated%3A2024-07-30..2026-02-05&type=Issues)) | @fcollonval ([activity](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Afcollonval+updated%3A2024-07-30..2026-02-05&type=Issues)) | @jtpio ([activity](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Ajtpio+updated%3A2024-07-30..2026-02-05&type=Issues)) | @krassowski ([activity](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Akrassowski+updated%3A2024-07-30..2026-02-05&type=Issues))
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 0.1.0a3
+
+([Full Changelog](https://github.com/jupyterlab/jupyter-builder/compare/v0.1.0a2...464a12d6a8288e06646f0c364ee1477d643c7261))
+
+### Maintenance and upkeep improvements
+
+- Bump ruff from 0.4.7 to 0.5.5 in the pip group across 1 directory [#24](https://github.com/jupyterlab/jupyter-builder/pull/24) ([@dependabot](https://github.com/dependabot))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterlab/jupyter-builder/graphs/contributors?from=2024-07-29&to=2024-07-30&type=c))
+
+[@dependabot](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Adependabot+updated%3A2024-07-29..2024-07-30&type=Issues)
+
+## 0.1.0a2
+
+([Full Changelog](https://github.com/jupyterlab/jupyter-builder/compare/ac6bb51518d309b96658dc45784f4d47a7cd559c...02764ce51fd919bdb5739e06d545656ee0e5b2c9))
+
+### Enhancements made
+
+- Include jlpm within this package (Issue #15) [#20](https://github.com/jupyterlab/jupyter-builder/pull/20) ([@cronan03](https://github.com/cronan03))
+- Watch feature and tests [#18](https://github.com/jupyterlab/jupyter-builder/pull/18) ([@cronan03](https://github.com/cronan03))
+- Build feature and Tests [#13](https://github.com/jupyterlab/jupyter-builder/pull/13) ([@cronan03](https://github.com/cronan03))
+- Develop command working [#11](https://github.com/jupyterlab/jupyter-builder/pull/11) ([@cronan03](https://github.com/cronan03))
+
+### Bugs fixed
+
+- Comment npm related release hook [#25](https://github.com/jupyterlab/jupyter-builder/pull/25) ([@fcollonval](https://github.com/fcollonval))
+
+### Maintenance and upkeep improvements
+
+- Scaffolding for adding a npm package and setting up the releaser [#23](https://github.com/jupyterlab/jupyter-builder/pull/23) ([@fcollonval](https://github.com/fcollonval))
+- Bump ruff from 0.4.2 to 0.4.7 in the pip group [#9](https://github.com/jupyterlab/jupyter-builder/pull/9) ([@dependabot](https://github.com/dependabot))
+- Bump ruff from 0.3.4 to 0.4.2 in the pip group [#7](https://github.com/jupyterlab/jupyter-builder/pull/7) ([@dependabot](https://github.com/dependabot))
+- Bump apache/skywalking-eyes from 97538682f556b56cc7422ece660d8d7e6c4fb013 to cd7b195c51fd3d6ad52afceb760719ddc6b3ee91 in the actions group [#6](https://github.com/jupyterlab/jupyter-builder/pull/6) ([@dependabot](https://github.com/dependabot))
+- Bump the pip group with 1 update [#5](https://github.com/jupyterlab/jupyter-builder/pull/5) ([@dependabot](https://github.com/dependabot))
+- Bump the actions group with 1 update [#4](https://github.com/jupyterlab/jupyter-builder/pull/4) ([@dependabot](https://github.com/dependabot))
+- Add skeleton [#2](https://github.com/jupyterlab/jupyter-builder/pull/2) ([@fcollonval](https://github.com/fcollonval))
+
+### Documentation improvements
+
+- Documentation  [#22](https://github.com/jupyterlab/jupyter-builder/pull/22) ([@cronan03](https://github.com/cronan03))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterlab/jupyter-builder/graphs/contributors?from=2024-03-04&to=2024-07-29&type=c))
+
+[@cronan03](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Acronan03+updated%3A2024-03-04..2024-07-29&type=Issues) | [@dependabot](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Adependabot+updated%3A2024-03-04..2024-07-29&type=Issues) | [@fcollonval](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Afcollonval+updated%3A2024-03-04..2024-07-29&type=Issues) | [@kloczek](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Akloczek+updated%3A2024-03-04..2024-07-29&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterlab%2Fjupyter-builder+involves%3Awelcome+updated%3A2024-03-04..2024-07-29&type=Issues)

jupyter_builder-0.1.0a4/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: jupyter_builder
+Version: 0.1.0a4
+Summary: JupyterLab build tools
+Project-URL: Homepage, https://jupyter.org
+Project-URL: Source, https://github.com/jupyterlab/jupyterlab_builder
+Project-URL: Issues, https://github.com/jupyterlab/jupyterlab_builder/issues/new/choose
+Project-URL: Gitter, https://gitter.im/jupyterlab/jupyterlab
+Project-URL: Pypi, https://pypi.org/project/jupyter-builder
+Author-email: Jupyter Development Team <jupyter@googlegroups.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, Jupyter Development Team
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: ipython,jupyter
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: jupyterlab-server
+Requires-Dist: traitlets
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: ruff==0.14.14; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: copier<10,>=9.3; extra == 'test'
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: jinja2-time; extra == 'test'
+Requires-Dist: jupyterlab; extra == 'test'
+Requires-Dist: pytest-check-links>=0.7; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Jupyter Builder
+
+Build tools for JupyterLab (and remixes)
+
+> \[!NOTE\]
+> This started by the extraction of the builder tools included in
+> the core [JupyterLab](https://github.com/jupyterlab/jupyterlab) during a GSoC project. See [below](#gsoc-2024-anecdote) for more information.
+
+## Why extracting the build tools?
+
+- This would also solve some chicken-and-egg problems like jupyterlab/jupyterlab_pygments#23.
+- Isolating the builder functionalities will simplify the work
+  of core and extension developers who can now focus on their respective parts of the
+  codebase instead of the earlier intertwined code.
+- It will in particular reduce the need to update the maintenance tooling to produce extension compatible with newer version of Jupyter app.
+
+## How to install the package?
+
+Execute the following command in a terminal:
+
+```
+pip install jupyter_builder
+```
+
+## What does it do?
+
+- Provides a CLI for building Jupyter extensions. There are 3 subcommands
+  - `build` : Builds the Jupyter extension JavaScript assets to be consumed by the Jupyter app.
+    ```
+    jupyter-builder build <path to extension folder>
+    ```
+  - `develop` : Install the Jupyter extension JavaScript assets in dev mode for consumption in the Jupyter app. It similar to [editable install mode of pip](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs)
+    ```
+    jupyter-builder develop --overwrite <path to extension folder>
+    ```
+  - `watch` : Automatically rebuild the development JavaScript assets when one file is changed to ease development.
+    ```
+    jupyter-builder watch <path to extension folder>
+    ```
+- Provides a NPM package manager: `jlpm`
+
+## How to uninstall the package?
+
+Execute the following command in a terminal:
+
+```
+pip uninstall jupyter_builder
+```
+
+______________________________________________________________________
+
+## GSoC 2024 Anecdote
+
+> Written by [@cronan03](https://github.com/cronan03) - GSoC Contributor 2024
+
+### Goal
+
+The goals of this project are:
+
+- to extract that tooling as a new separate package to ease maintenance (for core and extension developers)
+- update the existing package to use the new one
+- make it configurable to be reused for other applications.
+
+### What I did
+
+1. Successfully created a CLI with the processes `develop`, `build` and `watch` mentioned above.
+1. Created extensive unit tests using `Pytest` to ensure the processes run efficiently on any OS.
+1. Reduced external dependencies by bringing `jlpm` and `jupyterlab.semver` to the package.
+1. Pre released the package. It can be found on Pypi here https://pypi.org/project/jupyter-builder/
+1. Initiated a solution to the issue https://github.com/jupyterlab/jupyterlab/issues/13456
+
+### What's left to do
+
+1. We should bring `@jupyterlab/builder` within this package and make it generic.
+   For now the code lives there: https://github.com/jupyterlab/jupyterlab/tree/main/builder
+1. https://github.com/jupyterlab/jupyter-builder/blob/fffb100fc57ecb147bface4441f91bfd0cb6ff9a/jupyter_builder/federated_extensions.py#L296 which is responsible for checking version overlap has been temporarily ignored to make the build feature work.
+1. Update JupyterLab core to use this new package
+
+### Merged PRs
+
+1. https://github.com/jupyterlab/jupyter-builder/pull/11
+   - This PR focuses on extracting the `develop` feature which is responsible for installing the Jupyter extension JS assets in dev mode.
+   - Considering the size of [labextension.py](https://github.com/jupyterlab/jupyterlab/blob/main/jupyterlab/labextensions.py), only features essential to Jupyter builder were added.
+   - Each of the features will inherit from the class `BaseExtensionApp` present [here](https://github.com/jupyterlab/jupyter-builder/blob/main/jupyter_builder/base_extension_app.py)
+   - The [federated_extensions.py](https://github.com/jupyterlab/jupyter-builder/blob/main/jupyter_builder/federated_extensions.py)  sets up and executes commands to build, develop and waatch a JupyterLab extension. It resolves paths, constructs the appropriate command-line arguments, and executes the build process using `subprocess.check_call`. Optional parameters allow for customization of the build process, including logging, development mode, and source map generation.
+1. https://github.com/jupyterlab/jupyter-builder/pull/13
+   - This PR focuses on extracting the `build` feature which is responsible for creating the Javascript assets which will be consumed by the Jupyter App.
+   - It will always result in the creation of a file `static/style.js` in `<extension_folder>/myextension/labextension`.
+   - Tests have been crafted using `Pytest` to check for the existence of files mentioned above on running the `build` command.
+1. https://github.com/jupyterlab/jupyter-builder/pull/18
+   - The `watch` feature on running will rebuild the JS assets on being triggered. This happens on changing contents in `<extension_folder>/src/index.ts`
+   - To test this feature we deliberately make a change in `index.ts` triggering `watch`. This replaces old JS assets with new ones having different hash values in the file names. We create 2 vectors of filenames before and after triggering `watch` which will tell us if it actually worked.
+1. https://github.com/jupyterlab/jupyter-builder/pull/20
+   - To reduce external dependencies, we added `jlpm` to this package.
+   - It existed [here](https://github.com/jupyterlab/jupyterlab/blob/main/jupyterlab/jlpmapp.py) with the [entrypoint](https://github.com/jupyterlab/jupyterlab/blob/e048f27548969c0e4403417ac04bc186f119128f/pyproject.toml#L60).
+1. https://github.com/jupyterlab/jupyter-builder/pull/22
+   - Documented the working of the Jupyter builder along with installation guide.
+
+### Challenges and Learning
+
+1. One of the main challenges was starting this project from scratch with no pre existing code to rely on. I thank my mentor [@fcollonval](https://github.com/fcollonval) for creating the skeleton in https://github.com/jupyterlab/jupyter-builder/pull/2 which gave me a base to work on.
+1. Selecting relevant features for Jupyter builder from [labextension.py](https://github.com/jupyterlab/jupyterlab/blob/main/jupyterlab/labextensions.py) was really tough without a thorough understanding on which functions Jupyter builder would actually rely on.
+1. Creating tests for the `watch` feature was tricky as I had to carefully adjust sleep times to make sure the function was running before a change in `<extension_folder>/src/index.ts` was made. Otherwise the change happened before `watch` ran and never triggered it.

jupyter_builder-0.1.0a4/README.md

@@ -0,0 +1,103 @@
+# Jupyter Builder
+
+Build tools for JupyterLab (and remixes)
+
+> \[!NOTE\]
+> This started by the extraction of the builder tools included in
+> the core [JupyterLab](https://github.com/jupyterlab/jupyterlab) during a GSoC project. See [below](#gsoc-2024-anecdote) for more information.
+
+## Why extracting the build tools?
+
+- This would also solve some chicken-and-egg problems like jupyterlab/jupyterlab_pygments#23.
+- Isolating the builder functionalities will simplify the work
+  of core and extension developers who can now focus on their respective parts of the
+  codebase instead of the earlier intertwined code.
+- It will in particular reduce the need to update the maintenance tooling to produce extension compatible with newer version of Jupyter app.
+
+## How to install the package?
+
+Execute the following command in a terminal:
+
+```
+pip install jupyter_builder
+```
+
+## What does it do?
+
+- Provides a CLI for building Jupyter extensions. There are 3 subcommands
+  - `build` : Builds the Jupyter extension JavaScript assets to be consumed by the Jupyter app.
+    ```
+    jupyter-builder build <path to extension folder>
+    ```
+  - `develop` : Install the Jupyter extension JavaScript assets in dev mode for consumption in the Jupyter app. It similar to [editable install mode of pip](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs)
+    ```
+    jupyter-builder develop --overwrite <path to extension folder>
+    ```
+  - `watch` : Automatically rebuild the development JavaScript assets when one file is changed to ease development.
+    ```
+    jupyter-builder watch <path to extension folder>
+    ```
+- Provides a NPM package manager: `jlpm`
+
+## How to uninstall the package?
+
+Execute the following command in a terminal:
+
+```
+pip uninstall jupyter_builder
+```
+
+______________________________________________________________________
+
+## GSoC 2024 Anecdote
+
+> Written by [@cronan03](https://github.com/cronan03) - GSoC Contributor 2024
+
+### Goal
+
+The goals of this project are:
+
+- to extract that tooling as a new separate package to ease maintenance (for core and extension developers)
+- update the existing package to use the new one
+- make it configurable to be reused for other applications.
+
+### What I did
+
+1. Successfully created a CLI with the processes `develop`, `build` and `watch` mentioned above.
+1. Created extensive unit tests using `Pytest` to ensure the processes run efficiently on any OS.
+1. Reduced external dependencies by bringing `jlpm` and `jupyterlab.semver` to the package.
+1. Pre released the package. It can be found on Pypi here https://pypi.org/project/jupyter-builder/
+1. Initiated a solution to the issue https://github.com/jupyterlab/jupyterlab/issues/13456
+
+### What's left to do
+
+1. We should bring `@jupyterlab/builder` within this package and make it generic.
+   For now the code lives there: https://github.com/jupyterlab/jupyterlab/tree/main/builder
+1. https://github.com/jupyterlab/jupyter-builder/blob/fffb100fc57ecb147bface4441f91bfd0cb6ff9a/jupyter_builder/federated_extensions.py#L296 which is responsible for checking version overlap has been temporarily ignored to make the build feature work.
+1. Update JupyterLab core to use this new package
+
+### Merged PRs
+
+1. https://github.com/jupyterlab/jupyter-builder/pull/11
+   - This PR focuses on extracting the `develop` feature which is responsible for installing the Jupyter extension JS assets in dev mode.
+   - Considering the size of [labextension.py](https://github.com/jupyterlab/jupyterlab/blob/main/jupyterlab/labextensions.py), only features essential to Jupyter builder were added.
+   - Each of the features will inherit from the class `BaseExtensionApp` present [here](https://github.com/jupyterlab/jupyter-builder/blob/main/jupyter_builder/base_extension_app.py)
+   - The [federated_extensions.py](https://github.com/jupyterlab/jupyter-builder/blob/main/jupyter_builder/federated_extensions.py)  sets up and executes commands to build, develop and waatch a JupyterLab extension. It resolves paths, constructs the appropriate command-line arguments, and executes the build process using `subprocess.check_call`. Optional parameters allow for customization of the build process, including logging, development mode, and source map generation.
+1. https://github.com/jupyterlab/jupyter-builder/pull/13
+   - This PR focuses on extracting the `build` feature which is responsible for creating the Javascript assets which will be consumed by the Jupyter App.
+   - It will always result in the creation of a file `static/style.js` in `<extension_folder>/myextension/labextension`.
+   - Tests have been crafted using `Pytest` to check for the existence of files mentioned above on running the `build` command.
+1. https://github.com/jupyterlab/jupyter-builder/pull/18
+   - The `watch` feature on running will rebuild the JS assets on being triggered. This happens on changing contents in `<extension_folder>/src/index.ts`
+   - To test this feature we deliberately make a change in `index.ts` triggering `watch`. This replaces old JS assets with new ones having different hash values in the file names. We create 2 vectors of filenames before and after triggering `watch` which will tell us if it actually worked.
+1. https://github.com/jupyterlab/jupyter-builder/pull/20
+   - To reduce external dependencies, we added `jlpm` to this package.
+   - It existed [here](https://github.com/jupyterlab/jupyterlab/blob/main/jupyterlab/jlpmapp.py) with the [entrypoint](https://github.com/jupyterlab/jupyterlab/blob/e048f27548969c0e4403417ac04bc186f119128f/pyproject.toml#L60).
+1. https://github.com/jupyterlab/jupyter-builder/pull/22
+   - Documented the working of the Jupyter builder along with installation guide.
+
+### Challenges and Learning
+
+1. One of the main challenges was starting this project from scratch with no pre existing code to rely on. I thank my mentor [@fcollonval](https://github.com/fcollonval) for creating the skeleton in https://github.com/jupyterlab/jupyter-builder/pull/2 which gave me a base to work on.
+1. Selecting relevant features for Jupyter builder from [labextension.py](https://github.com/jupyterlab/jupyterlab/blob/main/jupyterlab/labextensions.py) was really tough without a thorough understanding on which functions Jupyter builder would actually rely on.
+1. Creating tests for the `watch` feature was tricky as I had to carefully adjust sleep times to make sure the function was running before a change in `<extension_folder>/src/index.ts` was made. Otherwise the change happened before `watch` ran and never triggered it.

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/__init__.py

@@ -9,5 +9,5 @@ except ImportError:
     # the package from a stable release or in editable mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
     import warnings
 
-    warnings.warn("Importing 'jupyter_builder' outside a proper installation.")
+    warnings.warn("Importing 'jupyter_builder' outside a proper installation.", stacklevel=1)
     __version__ = "dev"

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/base_extension_app.py

@@ -4,6 +4,7 @@
 # Distributed under the terms of the Modified BSD License.
 
 from __future__ import annotations
+
 import os
 from copy import copy
 
@@ -15,9 +16,6 @@ from .debug_log_file_mixin import DebugLogFileMixin
 
 HERE = os.path.dirname(os.path.abspath(__file__))
 
-
-# from .federated_labextensions import build_labextension, develop_labextension_py, watch_labextension
-
 flags = dict(base_flags)
 
 develop_flags = copy(flags)

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/commands.py

@@ -41,7 +41,8 @@ def _compare_ranges(spec1, spec2, drop_prerelease1=False, drop_prerelease2=False
     # Set return_value to a sentinel value
     return_value = False
 
-    # r1.set may be a list of ranges if the range involved an ||, so we need to test for overlaps between each pair.
+    # r1.set may be a list of ranges if the range involved an ||,
+    # so we need to test for overlaps between each pair.
     for r1set, r2set in itertools.product(r1.set, r2.set):
         x1 = r1set[0].semver
         x2 = r1set[-1].semver
@@ -78,14 +79,10 @@ def _compare_ranges(spec1, spec2, drop_prerelease1=False, drop_prerelease2=False
 
         # Check for overlap.
         if (
-            gte(x1, y1, True)
-            and ly(x1, y2, True)
-            or gy(x2, y1, True)
-            and ly(x2, y2, True)
-            or gte(y1, x1, True)
-            and lx(y1, x2, True)
-            or gx(y2, x1, True)
-            and lx(y2, x2, True)
+            (gte(x1, y1, True) and ly(x1, y2, True))
+            or (gy(x2, y1, True) and ly(x2, y2, True))
+            or (gte(y1, x1, True) and lx(y1, x2, True))
+            or (gx(y2, x1, True) and lx(y2, x2, True))
         ):
             # if we ever find an overlap, we can return immediately
             return 0

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/debug_log_file_mixin.py

@@ -47,18 +47,18 @@ class DebugLogFileMixin(Configurable):
             for line in msg:
                 self.log.debug(line)
             if isinstance(ex, SystemExit):
-                warnings.warn(f"An error occurred. See the log file for details: {log_path}")
+                warnings.warn(
+                    f"An error occurred. See the log file for details: {log_path}", stacklevel=1
+                )
                 raise
-            warnings.warn("An error occurred.")
-            warnings.warn(msg[-1].strip())
-            warnings.warn(f"See the log file for details: {log_path}")
+            warnings.warn("An error occurred.", stacklevel=1)
+            warnings.warn(msg[-1].strip(), stacklevel=1)
+            warnings.warn(f"See the log file for details: {log_path}", stacklevel=1)
             self.exit(1)
         else:
             log.removeHandler(_debug_handler)
             _debug_handler.flush()
             _debug_handler.close()
-            try:
+            with contextlib.suppress(FileNotFoundError):
                 os.remove(log_path)
-            except FileNotFoundError:
-                pass
         log.removeHandler(_debug_handler)

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/extension_commands/build.py

@@ -5,9 +5,9 @@ import os
 
 from traitlets import Bool, Unicode
 
-from ..base_extension_app import BaseExtensionApp
-from ..core_path import default_core_path
-from ..federated_extensions import build_labextension
+from jupyter_builder.base_extension_app import BaseExtensionApp
+from jupyter_builder.core_path import default_core_path
+from jupyter_builder.federated_extensions import build_labextension
 
 HERE = os.path.dirname(os.path.abspath(__file__))
 
@@ -27,7 +27,7 @@ class BuildLabExtensionApp(BaseExtensionApp):
         help="Directory containing core application package.json file",
     )
 
-    aliases = {
+    aliases = {  # noqa: RUF012
         "static-url": "BuildLabExtensionApp.static_url",
         "development": "BuildLabExtensionApp.development",
         "source-map": "BuildLabExtensionApp.source_map",

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/extension_commands/develop.py

@@ -7,8 +7,8 @@ from copy import copy
 from jupyter_core.application import base_flags
 from traitlets import Bool, Unicode
 
-from ..base_extension_app import BaseExtensionApp
-from ..federated_extensions import develop_labextension_py
+from jupyter_builder.base_extension_app import BaseExtensionApp
+from jupyter_builder.federated_extensions import develop_labextension_py
 
 flags = dict(base_flags)
 develop_flags = copy(flags)

{jupyter_builder-0.1.0a2 → jupyter_builder-0.1.0a4}/jupyter_builder/extension_commands/watch.py

@@ -5,9 +5,9 @@ import os
 
 from traitlets import Bool, Unicode
 
-from ..base_extension_app import BaseExtensionApp
-from ..federated_extensions import watch_labextension
-from ..core_path import default_core_path
+from jupyter_builder.base_extension_app import BaseExtensionApp
+from jupyter_builder.core_path import default_core_path
+from jupyter_builder.federated_extensions import watch_labextension
 
 HERE = os.path.dirname(os.path.abspath(__file__))
 
@@ -25,7 +25,7 @@ class WatchLabExtensionApp(BaseExtensionApp):
         help="Directory containing core application package.json file",
     )
 
-    aliases = {
+    aliases = {  # noqa: RUF012
         "core-path": "WatchLabExtensionApp.core_path",
         "development": "WatchLabExtensionApp.development",
         "source-map": "WatchLabExtensionApp.source_map",