Skip to content

Add some short installation and usage instructions #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add some short installation and usage instructions #107

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
593493b
Add `pipx`, `uvx`, installation instructions
agriyakhetarpal Feb 22, 2025
18f09e3
Prefer installation to directly running
agriyakhetarpal Feb 22, 2025
c39dde4
Mention `virtualenv` or `venv` preference
agriyakhetarpal Feb 22, 2025
bca1870
Simplify sentence on virtual environment usage
agriyakhetarpal Feb 22, 2025
b7708ff
Drop `--help` commands
agriyakhetarpal Feb 22, 2025
3ec2ab2
Collapse global installation section + reword
agriyakhetarpal Feb 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,50 @@ Tools for building Pyodide.
See [http://github.com/pyodide/pyodide](http://github.com/pyodide/pyodide) for
more information.

## Quickstart

### Usage

> [!TIP]
> Currently, installing `pyodide-build` is preferred to running it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this mean? I usually don't have the question "should I install this or should I run it" because usually I have to install first in order to run?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I meant to convey that users are better off installing pyodide-build (globally or in a virtual environment) rather than trying to use pipx or uvx (instructions for which are provided for completeness). I'll try to reword this sentence.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope 3ec2ab2 conveys the meaning better!


#### 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
```

> [!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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> [!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.
> [!NOTE]
> Currently `pyodide-build` does not work well in environments managed by uv, see #58.

I think this is the only thing in this PR that is appropriate for a readme. I think this adds a lot of noise, people can use pipx or uvx or venv or install pyodide-build globally or use whatever tools as they prefer. The readme isn't a tutorial on Python installer workflows.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me, thanks!


### or run it

- with `uv`/`uvx`

```bash
uvx --from pyodide-cli --with pyodide-build pyodide --help
```

## License

Pyodide uses the [Mozilla Public License Version
Expand Down