Skip to content

Commit

Permalink
Recommend using pipx to install maturin (#1859)
Browse files Browse the repository at this point in the history
  • Loading branch information
messense authored Nov 18, 2023
1 parent 95a41ed commit 91feb4b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@ Check out the [User Guide](https://maturin.rs/)!

## Usage

You can either download binaries from the [latest release](https://github.com/PyO3/maturin/releases/latest) or install it with pip:
You can either download binaries from the [latest release](https://github.com/PyO3/maturin/releases/latest) or install it with [pipx](https://pypa.github.io/pipx/):

```shell
pip install maturin
pipx install maturin
```

> **Note**
>
> `pip install maturin` should also work if you don't want to use pipx.
There are four main commands:

* `maturin new` creates a new cargo project with maturin configured.
Expand Down
10 changes: 7 additions & 3 deletions guide/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,22 @@

### PyPI

maturin is published as Python binary wheel to PyPI, you can install it using pip:
maturin is published as Python binary wheel to PyPI, you can install it using [pipx](https://pypa.github.io/pipx/):

```bash
pip install maturin
pipx install maturin
```

There are some extra dependencies for certain scenarios:

* `zig`: use zig as linker for easier cross compiling and manylinux compliance.
* `patchelf`: repair wheels that links other shared libraries.

For example, to install patchelf dependencies: `pip install maturin[patchelf]`.
For example, to install patchelf dependencies: `pipx install maturin[patchelf]`.

> **Note**
>
> `pip install maturin` should also work if you don't want to use pipx.
### Homebrew

Expand Down

0 comments on commit 91feb4b

Please sign in to comment.