Setuptools plugin for Rust extensions¶
setuptools-rust is a plugin for
setuptools to build Rust Python extensions implemented with PyO3 or rust-cpython.
Compile and distribute Python extensions written in Rust as easily as if they were written in C.
For a complete example, see html-py-ever.
First, you need to create a bunch of files:
from setuptools import setup from setuptools_rust import Binding, RustExtension setup( name="hello-rust", version="1.0", rust_extensions=[RustExtension("hello_rust.hello_rust", binding=Binding.PyO3)], packages=["hello_rust"], # rust extensions are not zip safe, just like C-extensions. zip_safe=False, )
For a complete reference of the options supported by the
RustExtension class, see the
[build-system] requires = ["setuptools", "wheel", "setuptools-rust"]
This file is required for building source distributions
include Cargo.toml recursive-include src *
You can use same commands as for c-extensions. For example:
>>> python ./setup.py develop running develop running egg_info writing hello-rust.egg-info/PKG-INFO writing top-level names to hello_rust.egg-info/top_level.txt writing dependency_links to hello_rust.egg-info/dependency_links.txt reading manifest file 'hello_rust.egg-info/SOURCES.txt' writing manifest file 'hello_rust.egg-info/SOURCES.txt' running build_ext running build_rust cargo build --manifest-path extensions/Cargo.toml --features python3 Finished debug [unoptimized + debuginfo] target(s) in 0.0 secs Creating /.../lib/python3.6/site-packages/hello_rust.egg-link (link to .) Installed hello_rust Processing dependencies for hello_rust==1.0 Finished processing dependencies for hello_rust==1.0
Or you can use commands like
bdist_wheel (after installing
wheel). See also the notes in the documentation about building wheels.
Cross-compiling is also supported, using one of
For examples see the
test-zigbuild Github actions jobs in
develop will create a debug build, while
install will create a release build.
build- Standard build command will also build all rust extensions.
build_rust- Command builds all rust extensions.
clean- Standard clean command executes cargo clean for all rust extensions.