pyo3/examples/maturin-starter/README.md

maturin-starter

An example of a basic Python extension module built using PyO3 and maturin.

Building and Testing

To build this package, first install maturin:

pip install maturin

To build and test use maturin develop:

pip install -r requirements-dev.txt
maturin develop && pytest

Alternatively, install tox and run the tests inside an isolated environment:

tox -e py

Copying this example

Use cargo-generate:

$ cargo install cargo-generate
$ cargo generate --git https://github.com/PyO3/pyo3 examples/maturin-starter

(cargo generate will take a little while to clone the PyO3 repo first; be patient when waiting for the command to run.)