pyo3/examples
Adam Reichold 39d19113fa Remove stale references to tox.ini from template substitution scripts. 2023-03-05 09:17:34 +01:00
..
decorator Remove stale references to tox.ini from template substitution scripts. 2023-03-05 09:17:34 +01:00
maturin-starter Remove stale references to tox.ini from template substitution scripts. 2023-03-05 09:17:34 +01:00
plugin release notes for 0.18.1 2023-02-07 21:38:07 +00:00
setuptools-rust-starter Remove stale references to tox.ini from template substitution scripts. 2023-03-05 09:17:34 +01:00
word-count Remove stale references to tox.ini from template substitution scripts. 2023-03-05 09:17:34 +01:00
Cargo.toml release notes for 0.18.1 2023-02-07 21:38:07 +00:00
README.md

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