History

David Hewitt bd3c3adf46 examples: make Cargo.toml files more uniform		2021-12-15 08:28:25 +00:00
..
decorator	examples: make Cargo.toml files more uniform	2021-12-15 08:28:25 +00:00
maturin-starter	examples: make Cargo.toml files more uniform	2021-12-15 08:28:25 +00:00
setuptools-rust-starter	examples: make Cargo.toml files more uniform	2021-12-15 08:28:25 +00:00
word-count	examples: make Cargo.toml files more uniform	2021-12-15 08:28:25 +00:00
Cargo.toml	Organize examples + add __call__ example (#2043 )	2021-12-15 00:45:26 +00:00
README.md	examples: add links to cargo-generate	2021-12-15 08:12:43 +00:00

PyO3 Examples

These example crates are a collection of toy extension modules built with PyO3. They are all tested using tox in PyO3's CI.

Below is a brief description of each of these:

Example	Description
`decorator`	A project showcasing the example from the Emulating callable objects chapter of the guide.
`maturin-starter`	A template project which is configured to use `maturin` for development.
`setuptools-rust-starter`	A template project which is configured to use `setuptools_rust` for development.
`word-count`	A quick performance comparison between word counter implementations written in each of Rust and Python.

Creating new projects from these examples

To copy an example, use cargo-generate. Follow the commands below, replacing <example> with the example to start from:

$ cargo install cargo-generate
$ cargo generate --git https://github.com/PyO3/pyo3 examples/<example>

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