pyo3/examples
Adam Reichold 0d30bb7d3d Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02:00
..
decorator Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02:00
maturin-starter Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02:00
plugin Bump MSRV to 1.56 2023-06-04 23:02:30 +01:00
setuptools-rust-starter Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02:00
word-count Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02:00
Cargo.toml Bump Rust edition to 2021 and make current Clippy happy. 2023-06-07 21:15:38 +02: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

README.md

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