pyo3/examples/maturin-starter
Matthew Neeley 68ec6de0c9
Use single-arg form of `#[pymodule]` function in docs and tests (#3899)
* Use single-arg form for `#[pymodule]` functions in docs and tests

* Update guide/src/function.md

Co-authored-by: Icxolu <10486322+Icxolu@users.noreply.github.com>

* Add test of two-argument module function

* Fix new test

---------

Co-authored-by: Icxolu <10486322+Icxolu@users.noreply.github.com>
2024-02-28 22:36:50 +00:00
..
.template release: 0.20.3 (#3890) 2024-02-23 12:30:38 +00:00
maturin_starter ci: switch from black to ruff 2023-10-26 21:04:49 +01:00
src Use single-arg form of `#[pymodule]` function in docs and tests (#3899) 2024-02-28 22:36:50 +00:00
tests examples: export __doc__ in example projects 2021-10-01 09:05:58 +01:00
Cargo.toml Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02:00
MANIFEST.in examples: maturin and setuptools_rust examples 2021-04-03 11:59:41 +01:00
README.md Switch from tox to nox 2022-01-17 00:24:33 +08:00
cargo-generate.toml Use `--no-build-isolation` 2022-01-17 10:02:03 +08:00
noxfile.py examples: remove requirements-dev.txt files 2023-10-26 08:24:30 +01:00
pyproject.toml examples: remove requirements-dev.txt files 2023-10-26 08:24:30 +01:00

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 nox and run the tests inside an isolated environment:

nox

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