Contributing#

Thank you for considering a contribution to jupyterlite-pyodide-lock.

We use pixi for local development and GitHub issues and pull requests to collaboration.

Pull Requests#

Before making a pull request, please ensure:

  • you’ve got a local setup

  • the following command runs without error:

pixi run pr

Local Development#

Set Up#

This project is developed locally and in CI with pixi, a relatively new approach to conda package management and task running.

Note

Refer to pixi.toml#/$schema for the current development version

If using mamba or conda (or some other $CONDA_EXE):

mamba install -c conda-forge "pixi ==0.48.0"  # replace `mamba` with your CONDA_EXE
Why pixi?

pixi provides the necessary primitives to:

  • capture complex environments, with python and other runtimes

  • install environments quickly, and cache well, but only when needed

  • run tasks, in the right environment, in the right order

  • skip tasks that have already run, and dependencies have not changed


Tasks and Environments#

See all the project info:

pixi info

See the available top-level pixi tasks:

pixi task list

Running Tasks#

Most tasks run just fine, and then stop:

pixi run all     # does all of the following, as needed
pixi run fix
pixi run build
pixi run lint
pixi run docs
pixi run check
pixi run test   # this takes a pretty long time

Some tasks run until stopped with ctrl+c:

pixi run serve-lab
pixi run serve-docs

Appendix: pixi tasks#

Task               Description
all                🚢 ALL tasks to prepare for a release
build              🏗️  build ALL packages
build-hash         ├ hash the built distributions
build-licenses     ├ ensure licenses in contrib packages
build-pypi         🐍 build ALL PyPI distributions
build-pypi-core    ├─ build core PyPI distributions
build-pypi-wd      ├─ build webdriver PyPI distributions
build-rattler      ├ build for conda distribution
build-wheel-check  ├ check the built wheels
build-wheel-twine  ├ check the built distributions for PyPI
check              🤓 check all build/test artifacts
check-links        ├ check links in html
check-spelling     ├ check spelling in documentation
dev-docs           ├ 🔁 watch and serve the documentation with autoreload
dev-lab            ├ 🔁 serve JupyterLab in the dev environment
dev-pip            ├ prepare the dev environment
docs               🖨️  build all documentation
docs-lite          ├ build a demo site with jupyter-lite
docs-pip           ├ prepare the docs environment with pip
docs-rtd           ├ copy the documentation site to where ReadTheDocs wants it
docs-scour         ├ optimize SVG for docs with scour
docs-sphinx        ├ build documentation with sphinx
fix                🧹 fix ALL source files
fix-conftest       ├ add templated conftest
fix-deps           ├ fix dependencies
fix-ipynb          ├ fix notebooks
fix-mdlint         ├ format markdown files with markdownlint2-cli
fix-prettier       ├ format web-adjacent files with prettier
fix-ruff           ├ fix python with ruff
fix-taplo          ├ fix toml with taplo
lint               ⭐ run ALL linters
lint-actionlint    ├ check GitHub actions with actionlint
lint-ipynb         ├ check notebooks
lint-mdlint        ├ check markdown files with markdownlint2-cli
lint-prettier      ├ check web-adjacent files with prettier
lint-ruff          ├ check python with ruff
pr                 🧲 run ALL pull request preflight tasks
test               🚀 run ALL tests
test-cli           ├ 🆘 check CLI in all test environments
test-max           ├ 🚗 run tests in the default test environment
test-max-cli       ├─ smoke test browsers in default test environment
test-max-core      ├─ test core in the default test environment
test-max-pip       ├─ prepare the default test environment with pip
test-max-wd        ├─ test webdriver in the default test environment
test-min           ├ 🐎 run tests in the oldest supported environment
test-min-cli       ├─ smoke test browsers in min test environment
test-min-core      ├─ test core in the min test environment
test-min-pip       ├─ prepare the min test environment with pip
test-min-wd        ├─ test webdriver in the min test environment
test-next          ├ 🛸 run tests in the prerelease environment
test-next-cli      ├─ smoke test browsers in next test environment
test-next-core     ├─ test core in the next test environment
test-next-pip      ├─ prepare the next test environment with pip
test-next-wd       ├─ test webdriver in the next test environment