Skip to content

docs: mention maturin develop --release in quickstart #6131

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
WaterWhisperer wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −0
Open

docs: mention maturin develop --release in quickstart #6131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ $ python
'25'
```

When checking runtime performance, run `maturin develop --release` to build with optimizations.

To make changes to the package, just edit the Rust source code and then re-run `maturin develop` to recompile.

To run this all as a single copy-and-paste, use the bash script below (replace `string_sum` in the first command with the desired package name):
Expand Down
3 changes: 3 additions & 0 deletions guide/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,9 @@ $ python
'25'
```

By default, `maturin develop` builds your Rust code with Cargo's default [`dev` profile](https://doc.rust-lang.org/cargo/reference/profiles.html#default-profiles), which includes debug information and limited optimizations.
When checking runtime performance, run `maturin develop --release` to build with Cargo's `release` profile and enable optimizations.

For more instructions on how to use Python code from Rust, see the [Python from Rust](python-from-rust.md) page.

## Maturin Import Hook
Expand Down