History

mejrs de27e5e41f refactor pyo3-ffi example to an example project		2023-10-09 23:45:14 +02:00
..
decorator	release: 0.19.2	2023-08-01 07:29:04 +01:00
getitem	simple getitem example	2023-06-15 16:39:25 -05:00
maturin-starter	release: 0.19.2	2023-08-01 07:29:04 +01:00
plugin	release: 0.19.2	2023-08-01 07:29:04 +01:00
setuptools-rust-starter	release: 0.19.2	2023-08-01 07:29:04 +01:00
string-sum	refactor pyo3-ffi example to an example project	2023-10-09 23:45:14 +02:00
word-count	release: 0.19.2	2023-08-01 07:29:04 +01:00
Cargo.toml	release: 0.19.2	2023-08-01 07:29:04 +01:00
README.md	added a plugin example that shows how to integrate a Python plugin into a Rust app while having option to test API without the main app	2023-01-27 08:34:09 +00:00

PyO3 Examples

These example crates are a collection of toy extension modules built with PyO3. They are all tested using nox 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.
`plugin`	Illustrates how to use Python as a scripting language within a Rust application

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