Splitting the package into voici-core and voici

.github/workflows/check-release.yml

@@ -1,4 +1,5 @@
 name: Check Release
+
 on:
   push:
     branches:
@@ -17,8 +18,13 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Base Setup
-        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Install Conda environment with Micromamba
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-name: voici
+          create-args: >-
+            python=3.9
+            yarn=3
 
       - name: Check Release
         uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2

.github/workflows/frontend.yml

@@ -1,5 +1,9 @@
 name: Build And Check Frontend Packages
 
+defaults:
+  run:
+    shell: bash -l {0}
+
 on:
   push:
     branches:
@@ -18,13 +22,14 @@ jobs:
       uses: actions/checkout@v3
 
     - name: Install Micromamba
-      uses: mamba-org/provision-with-micromamba@main
+      uses: mamba-org/setup-micromamba@v1
       with:
-        extra-specs: |
-          python=${{ matrix.python_version }}
+        environment-file: environment.yml
 
     - name: Lint
       run: |
         yarn
         yarn run eslint:check
         yarn run prettier:check
+      working-directory:
+        python/voici-core

.github/workflows/main.yml

@@ -29,16 +29,21 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Install Micromamba
-      uses: mamba-org/provision-with-micromamba@main
+      uses: mamba-org/setup-micromamba@v1
       with:
-        extra-specs: |
-          python=${{ matrix.python_version }}
+        environment-file: environment.yml
 
     - name: Lint (Python)
       run: |
         python -m ruff check .
         python -m black --check .
 
+    - name: Install voici
+      run: |
+        python -m pip install jupyterlite-xeus
+        python -m pip install python/voici-core
+        python -m pip install python/voici
+
     - name: Install browser
       run: |
         yarn
@@ -47,7 +52,6 @@ jobs:
 
     - name: Install dependencies and build tests
       run: |
-        python -m pip install .
         cd ui-tests
         yarn install --immutable
         yarn run build

.github/workflows/update_playwright_references.yaml

@@ -33,7 +33,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Install Micromamba
-        uses: mamba-org/provision-with-micromamba@main
+        uses: mamba-org/setup-micromamba@v1
 
       - name: Install dependencies and build tests
         run: |

LICENSE

@@ -1,6 +1,6 @@
 BSD License
 
-Copyright (c) 2018 Voilà contributors.
+Copyright (c) 2018-2024 Voilà contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

demo/environment.yml

@@ -1,8 +1,9 @@
 name: voici
 channels:
   - https://repo.mamba.pm/emscripten-forge
-  - https://repo.mamba.pm/conda-forge
+  - conda-forge
 dependencies:
+  - xeus-python
   - pandas
   - bqplot
   - ipycanvas

docs/conf.py

@@ -3,17 +3,13 @@
 # Add dev disclaimer.
 _release = {}
 exec(
-    compile(open("../voici/_version.py").read(), "../voici/_version.py", "exec"),
+    compile(
+        open("../python/voici/voici/_version.py").read(),
+        "../python/voici/voici/_version.py",
+        "exec",
+    ),
     _release,
 )
-if _release["version_info"][-1] == "dev":
-    rst_prolog = """
-    .. note::
-
-        This documentation is for a development version of Voilà. There may be
-        significant differences from the latest stable release.
-
-    """
 
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
@@ -33,7 +29,7 @@
 project = "voici"
 copyright = "2020, The Voilà Development Team"
 author = "The Voilà Development Team"
-version = ".".join(map(str, _release["version_info"][:2]))
+version = _release["__version__"]
 release = _release["__version__"]
 language = "en"
 

docs/deploy.md

@@ -25,13 +25,6 @@ You can also deploy Voici as a standalone application so it can be hosted anywhe
 
 First install Voici by following the [installation instructions](install.md).
 
-You also need to install a kernel for the language you want to use. For example, to use Python, you can install the `jupyterlite-xeus-python` package.
-Add it to your dependencies, or install it with the following command:
-
-```bash
-pip install jupyterlite-xeus-python
-```
-
 ### Build
 
 Let's assume you have a folder named `notebooks` with some notebooks in it. To build your Voici application, run the following command:

docs/environment.yml

@@ -9,6 +9,7 @@ dependencies:
   - pydata-sphinx-theme
   - yarn=3
   - pip:
-    - jupyterlite-xeus-python >= 1.0.0a0
     - sphinxcontrib-video
-    - ..
+    - jupyterlite-xeus
+    - ../python/voici-core
+    - ../python/voici

environment.yml

@@ -4,6 +4,7 @@ channels:
 dependencies:
   - pip
   - black
+  - ruff
   - pytest
   - yarn=3
   - nodejs=18
@@ -12,4 +13,3 @@ dependencies:
     - voila>=0.5.5
     - voila-material>=0.4.3
     - jupyterlite-core[lab]>=0.2.0,<0.3.0
-    - jupyterlite-xeus-python >= 1.0.0a3

pyproject.toml

@@ -1,140 +1,24 @@
 [build-system]
-requires = [
-    "hatchling>=1.8.1",
-    "jupyter_core",
-]
 build-backend = "hatchling.build"
+requires = ["hatchling>=1.5.0,<2"]
 
 [project]
-name = "voici"
-description = "Voici turns Jupyter notebooks into static web applications"
+name = "voici-root"
 readme = "README.md"
-requires-python = ">=3.8"
-authors = [
-    { name = "Voila Development Team" },
-]
-keywords = [
-    "Jupyter",
-    "JupyterLite",
-    "Emscripten",
-    "Voila",
-    "Voici",
-]
-classifiers = [
-    "Framework :: Jupyter",
-    "License :: OSI Approved :: BSD License",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-]
-dependencies = [
-    "voila>=0.5.5,<0.6",
-    "jupyterlite-core>=0.2.0,<0.3.0",
-]
-dynamic = [
-    "version",
-]
-
-[project.license]
-file = "LICENSE"
-
-[project.optional-dependencies]
-dev = [
-    "black",
-    "ruff==0.0.258",
-    "hatch",
-]
-
-docs = [
-    "myst-parser",
-    "pydata-sphinx-theme",
-    "sphinx",
-    "sphinx-autobuild",
-    "sphinxcontrib-video",
-]
-
-[project.scripts]
-voici = "voici.app:main"
-
-[project.entry-points."jupyterlite.addon.v0"]
-voici = "voici.addon:VoiciAddon"
-
-[project.urls]
-Homepage = "https://github.com/voila-dashboards/voici"
+license = { file = "LICENSE" }
+dynamic = ["version"]
 
 [tool.hatch.version]
-path = "voici/_version.py"
-
-[tool.hatch.build]
-artifacts = [
-    "voici/static/build",
-]
-
-[tool.hatch.build.targets.sdist]
-exclude = [
-    ".github",
-    "*.gif",
-]
-
-[tool.hatch.build.hooks.jupyter-builder]
-dependencies = [
-    "hatch-jupyter-builder>=0.5.3",
-]
-build-function = "hatch_jupyter_builder.npm_builder"
-ensured-targets = [
-    "voici/static/build/voici.js",
-]
-skip-if-exists = [
-    "voici/static/build/voici.js",
-]
-
-[tool.hatch.build.hooks.jupyter-builder.editable-build-kwargs]
-build_cmd = "build"
-npm = [
-    "yarn",
-]
-force = true
-
-[tool.hatch.build.hooks.jupyter-builder.build-kwargs]
-build_cmd = "build:prod"
-npm = [
-    "yarn",
-]
+path = "python/voici/voici/_version.py"
 
 [tool.jupyter-releaser]
-skip = [
-    "check-links",
-]
-
-[tool.jupyter-releaser.hooks]
-before-bump-version = [
-    "python -m pip install hatch",
-]
-before-build-npm = [
-    "yarn",
-    "yarn clean",
-    "yarn build:prod",
-]
-before-build-python = [
-    "yarn clean",
-]
+skip = [ "check-python" ]
 
 [tool.jupyter-releaser.options]
-version-cmd = "python scripts/bump-version.py"
+python_packages = [
+    "python/voici:voici",
+    "python/voici-core:voici-core",
+]
 
 [tool.check-wheel-contents]
 ignore = ["W002"]
-
-[tool.ruff]
-target-version = "py38"
-line-length = 100
-
-[tool.hatch.envs.docs]
-features = ["docs"]
-[tool.hatch.envs.docs.scripts]
-build = "sphinx-build -W -b html docs docs/build/html"
-watch = "sphinx-autobuild -W -b html docs docs/build/html --host 0.0.0.0"
-serve = "python -m http.server --directory docs/build/html"

python/voici-core/LICENSE

@@ -0,0 +1,32 @@
+BSD License
+
+Copyright (c) 2018-2024 Voilà contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  a. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+  b. 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.
+
+  c. Neither the name of the authors nor the names of the contributors to
+     this package 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 REGENTS 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.