Merge pull request #42 from renan-r-santos/multiple-envs

Add support for Pixi environments

Author: renan-r-santos

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        pixi-version: ["0.30.0", "0.39.3"]
+        pixi-version: ["0.30.0", "0.39.4"]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repo

.gitignore

@@ -26,3 +26,11 @@ dist
 
 # System
 .DS_Store
+
+# Frontend
+lib
+node_modules
+.yarn
+tsconfig.tsbuildinfo
+.eslintcache
+pixi_kernel/labextension

.prettierignore

@@ -0,0 +1,4 @@
+node_modules
+lib
+pixi_kernel
+kernels

.prettierrc.json

@@ -0,0 +1,14 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "arrowParens": "avoid",
+  "endOfLine": "auto",
+  "overrides": [
+    {
+      "files": "package.json",
+      "options": {
+        "tabWidth": 4
+      }
+    }
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "JupyterLab",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${workspaceFolder}/.venv/bin/jupyter-lab",
+      "console": "integratedTerminal",
+      "args": [
+        "-y",
+        "--no-browser",
+        "--ContentsManager.allow_hidden=True",
+        "--notebook-dir",
+        "../notebooks"
+      ],
+      "justMyCode": false
+    }
+  ]
+}

.vscode/settings.json

@@ -1,14 +1,14 @@
 {
   "[python]": {
     "editor.codeActionsOnSave": {
-        "source.organizeImports": "always"
+      "source.organizeImports": "always"
     },
     "editor.defaultFormatter": "charliermarsh.ruff"
   },
   "editor.formatOnSave": true,
   "editor.rulers": [99],
   "python.testing.pytestArgs": ["tests/unit"],
-  "python.testing.pytestEnabled": true,
+  "python.testing.pytestEnabled": true
 
   // Uncomment the following lines to enable unittest.
   // Apparently VSCode cant' handle unittest and pytest at the same time.

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-Pixi Kernel is free and open source software developed under an MIT license. Development occurs at
+Pixi kernel is free and open source software developed under an MIT license. Development occurs at
 the [GitHub project](https://github.com/renan-r-santos/pixi-kernel). Contributions are welcome.
 
 Bug reports and feature requests may be made directly on the
@@ -11,23 +11,29 @@ tests, push the changes, and [open a PR](https://github.com/renan-r-santos/pixi-
 
 ## Cloning the repo
 
-To make a local copy of Pixi Kernel, clone the repository with git:
+To make a local copy of Pixi kernel, clone the repository with git:
 
 ```
 git clone https://github.com/renan-r-santos/pixi-kernel.git
 ```
 
 ## Installing system dependencies
 
-Pixi Kernel uses `uv` as its packaging and dependency manager. Follow the
+Pixi kernel uses `uv` as its packaging and dependency manager. Follow the
 [official docs](https://docs.astral.sh/uv) for installing `uv`.
 
-Additionally, Pixi Kernel needs `pixi` to run tests. Follow the [official docs](https://pixi.sh)
+Additionally, Pixi kernel needs `pixi` to run tests. Follow the [official docs](https://pixi.sh)
 for installing `pixi`.
 
+Install the project dependencies with:
+
+```
+uv sync
+```
+
 ## Testing and code quality
 
-Pixi Kernel uses `pytest`, `unittest` and `tox` to run the tests in the `tests/` directory.
+Pixi kernel uses `pytest`, `unittest` and `tox` to run the tests in the `tests/` directory.
 To run all of them, use:
 
 ```
@@ -43,7 +49,7 @@ uv run tox run -e py313-test
 
 ## Code quality
 
-Pixi Kernel uses Ruff and MyPy to ensure a minimum standard of code quality. The code quality
+Pixi kernel uses Ruff and MyPy to ensure a minimum standard of code quality. The code quality
 commands are encapsulated with `uv` and `tox`:
 
 ```
@@ -55,7 +61,7 @@ uv run tox run -e type_check
 ## Making a release
 
 1. Bump
-   1. Increment version in `pyproject.toml`
+   1. Increment version in `pyproject.toml` and `package.json`
    2. Update all lock files by running `uv sync -U` and `pixi update`
    3. Commit with message "chore: Bump version number to X.Y.Z"
    4. Push commit to GitHub
@@ -69,4 +75,4 @@ uv run tox run -e type_check
    4. Check [PyPI](https://pypi.org/project/pixi-kernel/) for good upload
 3. Document
    1. Create [GitHub release](https://github.com/renan-r-santos/pixi-kernel/releases) with name
-      "Pixi Kernel X.Y.Z" and major changes in body
+      "Pixi kernel X.Y.Z" and major changes in body

README.md

@@ -1,4 +1,4 @@
-# Pixi Kernel
+# Pixi kernel
 
 [![image](https://img.shields.io/pypi/v/pixi-kernel)](https://pypi.python.org/pypi/pixi-kernel)
 [![image](https://img.shields.io/pypi/l/pixi-kernel)](https://pypi.python.org/pypi/pixi-kernel)
@@ -12,9 +12,10 @@ Per-directory Pixi environments with multi-language Jupyter kernels.
 
 <!--- TODO: add theme selector when supported on PyPI https://github.com/pypi/warehouse/issues/11251 -->
 
-![JupyterLab launcher screen showing Pixi Kernel](https://raw.githubusercontent.com/renan-r-santos/pixi-kernel/main/assets/launch-light.png)
+![JupyterLab launcher screen showing Pixi kernel](https://raw.githubusercontent.com/renan-r-santos/pixi-kernel/main/assets/launch-light.png)
 
-Pixi Kernel supports Python 3.9+ and Pixi 0.30.0+ using `pyproject.toml` and `pixi.toml` configurations.
+Pixi kernel supports Jupyterlab 4, Python 3.9+ and Pixi 0.30.0+ using `pyproject.toml` and
+`pixi.toml` configurations.
 
 **Disclaimer**: _This project is not affiliated with Pixi, and not an official Pixi plugin._
 
@@ -32,7 +33,7 @@ See the [Pixi docs](https://pixi.sh/latest/) for more information on how to use
 
 ## Kernel support
 
-Pixi Kernel supports the following kernels:
+Pixi kernel supports the following kernels:
 
 | Language | Kernel         | Package name                                       |
 | -------- | -------------- | -------------------------------------------------- |
@@ -42,11 +43,16 @@ Pixi Kernel supports the following kernels:
 Support for other kernels and languages can be added by opening an issue or a pull request, see
 [CONTRIBUTING](CONTRIBUTING.md#adding-support-for-new-kernels).
 
+## Pixi environments
+
+Pixi kernel supports multiple Pixi environments in a single Pixi project. To select a specific
+environment, use JupyterLab property inspector, save your notebook and restart your kernel.
+
+![JupyterLab property inspector showing Pixi environment selector](https://raw.githubusercontent.com/renan-r-santos/pixi-kernel/main/assets/env-selector-light.png)
+
 ## Limitations
 
-Pixi Kernel only works with the default environment. If you have an idea how to support multiple
-environments see [this issue](https://github.com/renan-r-santos/pixi-kernel/issues/20) or see
-[CONTRIBUTING](CONTRIBUTING.md#adding-support-for-new-kernels).
+Pixi kernel only works with the default environment in VSCode.
 
 ## Related