From 593493ba4176a76d96778395261b7ffdad8c5079 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 22 Feb 2025 21:33:33 +0530 Subject: [PATCH 1/6] Add `pipx`, `uvx`, installation instructions --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 62812d0a..a20e02fb 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,43 @@ Tools for building Pyodide. See [http://github.com/pyodide/pyodide](http://github.com/pyodide/pyodide) for more information. +## Quickstart + +### Usage + +#### Install it + +```bash +pip install pyodide-build +pyodide --help +pyodide build --help +``` + +#### Install it globally + +```bash +pipx install --include-deps pyodide-build +pyodide --help +pyodide build --help +``` + +or, alternatively + +```bash +pipx install pyodide-cli +pipx inject pyodide-cli pyodide-build +pyodide --help +pyodide build --help +``` + +### or run it + +- with `uv`/`uvx` + +```bash +uvx --from pyodide-cli --with pyodide-build pyodide --help +``` + ## License Pyodide uses the [Mozilla Public License Version From 18f09e3c39b52163365dafaddbc08a186a1db19d Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 22 Feb 2025 21:35:02 +0530 Subject: [PATCH 2/6] Prefer installation to directly running --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a20e02fb..3998c1f1 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,9 @@ more information. ### Usage +> [!TIP] +> Currently, installing `pyodide-build` is preferred to running it. + #### Install it ```bash From c39dde4430aa52e4ec7f11e29fbefcb435e86130 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 22 Feb 2025 21:46:19 +0530 Subject: [PATCH 3/6] Mention `virtualenv` or `venv` preference --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3998c1f1..dcd0dce4 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ pyodide --help pyodide build --help ``` +> [!NOTE] +> If installing `pyodide-build` and its dependencies in virtual environments, we recommend +using ones that are managed by `venv` or `virtualenv` at the moment; see #58. + ### or run it - with `uv`/`uvx` From bca1870d1e2df49edcfa6ab71e350e18d1801cce Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 22 Feb 2025 22:58:44 +0530 Subject: [PATCH 4/6] Simplify sentence on virtual environment usage Co-authored-by: Hood Chatham --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index dcd0dce4..3684687d 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,7 @@ pyodide build --help ``` > [!NOTE] -> If installing `pyodide-build` and its dependencies in virtual environments, we recommend -using ones that are managed by `venv` or `virtualenv` at the moment; see #58. +> Currently `pyodide-build` does not work well in environments managed by uv, see #58. ### or run it From b7708ff5707fda9d41d59cceb2bad1e52577f3fd Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 22 Feb 2025 22:59:25 +0530 Subject: [PATCH 5/6] Drop `--help` commands --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 3684687d..18324bd1 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,12 @@ more information. ```bash pip install pyodide-build -pyodide --help -pyodide build --help ``` #### Install it globally ```bash pipx install --include-deps pyodide-build -pyodide --help -pyodide build --help ``` or, alternatively @@ -33,8 +29,6 @@ or, alternatively ```bash pipx install pyodide-cli pipx inject pyodide-cli pyodide-build -pyodide --help -pyodide build --help ``` > [!NOTE] From 3ec2ab2c63679c29a82b4fc6f7416bc7c29ad52b Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 22 Feb 2025 23:07:46 +0530 Subject: [PATCH 6/6] Collapse global installation section + reword --- README.md | 22 +++++----------------- 1 file changed, 5 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 18324bd1..44e6df5c 100644 --- a/README.md +++ b/README.md @@ -10,31 +10,19 @@ more information. ### Usage > [!TIP] -> Currently, installing `pyodide-build` is preferred to running it. +> Currently, installing `pyodide-build` is the recommended to use it, instead of running it directly. #### Install it ```bash -pip install pyodide-build -``` - -#### Install it globally - -```bash -pipx install --include-deps pyodide-build -``` - -or, alternatively - -```bash -pipx install pyodide-cli -pipx inject pyodide-cli pyodide-build +pip install pyodide-build # in an environment +pipx install --include-deps pyodide-build # globally ``` > [!NOTE] -> Currently `pyodide-build` does not work well in environments managed by uv, see #58. +> Currently `pyodide-build` does not work well in virtual environments managed by `uv`, see #58. -### or run it +#### or run it - with `uv`/`uvx`