Split Python and JavaScript packages (#1168)

* Split directory structure

* Too much green

* Rename things

* Split packages

* Update gitignore

* Remove lib dir from git

* Restore examples

* Update install path in workflow

* Update main workflow

* Use the right directory name

* Update working directory for linter CI

* Fix linting CI

* Update ui-tests workflow

* Update python versions and readme paths

* Rename python module

* Remove unnecessary files

* Update build targets

* Update meta build targets

* Update doc environments

* Remove some files

* Update paths in documentation

* Remove MANIFEST

* Update docs environment files

* Update doc environemtns again

* Add ipyleaflet to the lite deployment

---------

Co-authored-by: martinRenou <[email protected]>

Author: gjmooney

.github/workflows/main.yml

@@ -34,14 +34,14 @@ jobs:
               - python==${{ matrix.python-version }}
 
       - name: Install ipyleaflet
-        run: pip install . --no-deps
+        run: pip install python/jupyter_leaflet python/ipyleaflet_core python/ipyleaflet --no-deps
 
       - name: Check installation files
         run: |
           test -d $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-leaflet
           test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-leaflet/extension.js
           test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-leaflet/index.js
-          test -d $CONDA_PREFIX/share/jupyter/labextensions/jupyter-leaflet
+          test -f $CONDA_PREFIX/share/jupyter/nbextensions/jupyter-leaflet/index.js
           test -f $CONDA_PREFIX/share/jupyter/labextensions/jupyter-leaflet/package.json
 
       - name: Python Linters
@@ -51,7 +51,7 @@ jobs:
         run: |
           yarn install
           yarn run lint:check
-        working-directory: js
+        working-directory: python/jupyter_leaflet
 
       - name: Import check
         run: python -c 'import ipyleaflet'

.github/workflows/ui-tests.yml

@@ -2,7 +2,6 @@ name: UI Tests
 
 on: [push, pull_request]
 
-
 defaults:
   run:
     shell: bash -l {0}
@@ -26,7 +25,7 @@ jobs:
           channels: conda-forge
 
       - name: Install ipyleaflet
-        run: pip install . --no-deps
+        run: pip install python/jupyter_leaflet python/ipyleaflet_core python/ipyleaflet --no-deps
 
       - name: Install browser
         run: |

.gitignore

@@ -5,21 +5,19 @@ build/
 *.py[cod]
 node_modules/
 *package-lock.json
-js/.yarn/
+python/jupyter_leaflet/.yarn/
 ui-tests/.yarn/
 
 # Compiled javascript
-ipyleaflet/nbextension/
-ipyleaflet/labextension/
-js/dist/
-js/lib/
+python/jupyter_leaflet/nbextension/
+python/jupyter_leaflet/labextension/
+python/jupyter_leaflet/dist/
+python/jupyter_leaflet/lib/
 
 # OS X
 .DS_Store
 .idea/
 
-js/jupyter-leaflet-*.tgz
-
 # Documentation data files
 docs/*.csv
 docs/*.json

MANIFEST.in

@@ -5,13 +5,13 @@
    git clone [email protected]:jupyter-widgets/ipyleaflet.git
    ```
 2. Update the version numbers in the following files (see https://github.com/jupyter-widgets/ipyleaflet/commit/48f3cb68cd07e6c4ae7b353a17861e4e51ca4471)
-   - `ipyleaflet/_version.py` (two places)
-   - `js/package.json`
+   - `ipyleaflet/ipyleaflet_core/ipyleaflet/_version.py` (two places)
+   - `ipyleaflet/python/jupyter_leaflet/package.json`
    - `environment.yml`
 3. Make sure the changelog is updated: `CHANGELOG.md`
 4. Build and publish to npm (if yarn prompts for the new version, I give the same as what is already in the `package.json`)
    ```sh
-   cd js
+   cd ipyleaflet/python/jupyter_leaflet
    yarn install && yarn run build && yarn publish
    cd ..
    ```
@@ -20,7 +20,7 @@
    python -m build
    twine upload dist/*
    ```
-6. Update environment environment config with new ipyleaflet pypi download link: `docs/jupyterlite_config.json`
+6. Update environment config with new ipyleaflet pypi download link: `docs/jupyterlite_config.json`
 7. Commit and push in git
    ```sh
    git commit -am "Release <VERSION>"

RELEASE.md

@@ -8,6 +8,7 @@ dependencies:
   - jupyterlab~=4.0
   - jupyter-packaging~=0.12
   - jupyter-sphinx
+  - build
   - scipy
   - netcdf4
   - geopandas
@@ -18,4 +19,7 @@ dependencies:
   - jupyterlite-sphinx
   - jupyterlite-xeus-python >=0.9.2,<0.10
   - pip:
-      - ..
+      - ../python/jupyter_leaflet
+      - ../python/ipyleaflet_core
+      - ../python/ipyleaflet
+      - ../python/ipyleaflet

docs/build-environment.yml

@@ -9,4 +9,7 @@ dependencies:
   - xyzservices
   - branca
   - pip:
-    - ..
+      - ../python/jupyter_leaflet
+      - ../python/ipyleaflet_core
+      - ../python/ipyleaflet
+      - ../python/ipyleaflet

docs/environment.yml

@@ -48,7 +48,7 @@ Note for developers:
 - the ``-e`` pip option allows one to modify the Python code in-place. Restart the kernel in order to see the changes.
 - the ``--symlink`` argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.
 
-    For automatically building the JavaScript code every time there is a change, run the following command from the ``ipyleaflet/js/`` directory:
+    For automatically building the JavaScript code every time there is a change, run the following command from the ``ipyleaflet/python/jupyter_leaflet`` directory:
 
     .. code:: bash