pyo3/examples/maturin-starter/README.md
David Hewitt 0ae7b69295
examples: add links to packaging tools
Co-authored-by: Yuji Kanagawa <yuji.kngw.80s.revive@gmail.com>
2021-04-03 12:50:42 +01:00

25 lines
460 B
Markdown

# maturin-starter
An example of a basic Python extension module built using PyO3 and [`maturin`](https://github.com/PyO3/maturin).
## Building and Testing
To build this package, first install `maturin`:
```shell
pip install maturin
```
To build and test use `maturin develop`:
```shell
pip install -r requirements-dev.txt
maturin develop && pytest
```
Alternatively, install tox and run the tests inside an isolated environment:
```shell
tox -e py
```