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.
Setup
For a complete example, see html-py-ever.
First, you need to create a bunch of files:
setup.py
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
API reference.
pyproject.toml
[build-system]
requires = ["setuptools", "wheel", "setuptools-rust"]
MANIFEST.in
This file is required for building source distributions
include Cargo.toml
recursive-include src *
Usage
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 crossenv, cross or cargo-zigbuild.
For examples see the test-crossenv and test-cross and test-zigbuild Github actions jobs in ci.yml.
By default, develop will create a debug build, while install will create a release build.
Commands
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.
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file setuptools-rust-1.4.1.tar.gz.
File metadata
- Download URL: setuptools-rust-1.4.1.tar.gz
- Upload date:
- Size: 288.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
18ff850831f58ee21d5783825c99fad632da21e47645e9427fd7dec048029e76
|
|
| MD5 |
c51ca03d0a6a91ffc3a036822a2deb54
|
|
| BLAKE2b-256 |
edc68effd679eb1cb6d3fd9fc7837cf86c6e4c1ba7a33c3e5e35c741c04016c5
|
File details
Details for the file setuptools_rust-1.4.1-py3-none-any.whl.
File metadata
- Download URL: setuptools_rust-1.4.1-py3-none-any.whl
- Upload date:
- Size: 23.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.1 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
12b5350d75008f2d4b64a991aba0358bb7ef45502bad086990b019a760afec67
|
|
| MD5 |
98e1586e6f71d4c60bd59f8fd3d32d8f
|
|
| BLAKE2b-256 |
c4d3b101f6af5d70988a89fa2b5d7f0d9bc92974014e3eb61ee3802966dc07a6
|
