pyo3/examples/maturin-starter
2021-12-15 08:28:25 +00:00
..
.template examples: make Cargo.toml files more uniform 2021-12-15 08:28:25 +00:00
maturin_starter examples: export __doc__ in example projects 2021-10-01 09:05:58 +01:00
src examples: export __doc__ in example projects 2021-10-01 09:05:58 +01:00
tests examples: export __doc__ in example projects 2021-10-01 09:05:58 +01:00
cargo-generate.toml examples: add cargo-generate configuration 2021-12-15 08:11:46 +00:00
Cargo.toml examples: make Cargo.toml files more uniform 2021-12-15 08:28:25 +00:00
MANIFEST.in examples: maturin and setuptools_rust examples 2021-04-03 11:59:41 +01:00
pyproject.toml examples: add cargo-generate configuration 2021-12-15 08:11:46 +00:00
README.md examples: add links to cargo-generate 2021-12-15 08:12:43 +00:00
requirements-dev.txt examples: use pip 21.3 2021-10-13 00:05:33 +01:00
tox.ini examples: use pip 21.3 2021-10-13 00:05:33 +01:00

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.)