Skip to main content

Rust extension builder shipped with rust toolchain

Project description

setuptools-rust-bundled rustc cargo Packaging and test PyPI

A zero-setup build helper that lets you ship Python wheels or source distributions backed by Rust—even on machines that have no Rust tool-chain installed. It transparently wraps either setuptools-rust or maturin, downloading rustc, cargo, and the target standard libraries on-demand so the underlying backend “just works”.

✨ Key features

  • The wheel packages of setuptools-rust-bundled are shipped with toolchain binaries, so you can skip downloading or installing toolchain in build process.
  • setuptools-rust-bundled provides sdist, and wheels for many underlying environments, so you can support many systems just using this library.

😊 Distribution

  • sdist package is distributed via PyPI.
  • wheel packages are available at releases page

🚀 Quick start

Below are minimal pyproject.toml snippets for the two supported backends.

1. using setuptools-rust (recommended)

[build-system]
requires = ["setuptools>=64", "setuptools-rust", "setuptools-rust-bundled"]
build-backend = "setuptools_rust_bundled.setuptools"

[project]
name = "example"
version = "0.1.0"

[[tool.setuptools-rust.ext-modules]]
target = "example.example"

[tool.setuptools.packages]
find = { where = ["."] }

2. using maturin

Because maturin itself is written in Rust, it cannot run on systems where the Rust toolchain is not installed and a pre-built maturin wheel is unavailable.

[build-system]
requires = ["setuptools-rust-bundled", "maturin>=1.0,<2.0"]
build-backend = "setuptools_rust_bundled.maturin"

[project]
name = "example"
version = "0.1.0"

[tool.maturin]
python-source = "."
module-name = "example.example"

3. using wheel version of setuptools-rust-bundled

We distribute wheel packages of setuptools-rust-bundled via GitHub Release. To use it as build backend, follow this example:

[build-system]
requires = [
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_x86_64.whl ; sys_platform=='linux' and platform_machine=='x86_64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-macosx_11_0_arm64.whl ; sys_platform=='darwin' and platform_machine== 'arm64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-macosx_10_12_x86_64.whl ; sys_platform=='darwin' and platform_machine== 'x86_64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-win_amd64.whl ; sys_platform=='win32' and platform_machine=='AMD64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_aarch64.whl ; sys_platform=='linux' and platform_machine=='aarch64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_armv7l.whl ; sys_platform=='linux' and platform_machine=='armv7l'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_i686.whl ; sys_platform=='linux' and platform_machine=='i686'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_ppc64le.whl ; sys_platform=='linux' and platform_machine=='ppc64le'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_riscv64.whl ; sys_platform=='linux' and platform_machine=='riscv64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-manylinux_2_17_s390x.whl ; sys_platform=='linux' and platform_machine=='s390x'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-win_arm64.whl ; sys_platform=='win32' and platform_machine=='ARM64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-freebsd_14_2_release_amd64.whl ; sys_platform=='freebsd14' and platform_machine=='amd64'",
  "setuptools-rust-bundled@https://github.com/QunaSys/setuptools-rust-bundled/releases/download/v0.1.4/setuptools_rust_bundled-0.1.4-py3-none-netbsd_10_1_amd64.whl ; sys_platform=='netbsd10' and platform_machine=='amd64'",
  "setuptools-rust-bundled==0.1.4",
  # ... other deps (like setuptools, setuptools-rust, maturin)
]
# ...

📝 Developing setuptools-rust-bundled

Build setuptools-rust-bundled

Use these commands to build development version of setuptools-rust-bundled:

# Build sdist in `dist/`
python setup.py sdist
# Build wheel in `dist/`
python setup.py bdist_wheel -p <platform>

Build example packages with setuptools-rust-bundled

# Install dependencies for setuptools-rust-bundled
pip install setuptools wheel requests tomli
# Install setuptools-rust-bundled from source
pip install .
# Or install from package
pip install dist/*
# Install examples
cd examples/setuptools
pip install --no-build-isolation -v .

🛠️ Available toolchain

Tool Version
rustc 1.86.0
cargo 0.87.0
rust-std 1.86.0

💻 Supported systems

Python platform tag Rust platform tag sdist install tested maturin supported setuptools supported
manylinux_2_17_i686 i686-unknown-linux-gnu YES
manylinux_2_17_x86_64 x86_64-unknown-linux-gnu YES YES YES
manylinux_2_17_aarch64 aarch64-unknown-linux-gnu YES YES YES
manylinux_2_17_riscv64 riscv64gc-unknown-linux-gnu YES
manylinux_2_17_armv7l armv7-unknown-linux-gnueabihf YES YES
manylinux_2_17_ppc64le powerpc64le-unknown-linux-gnu YES YES
manylinux_2_17_s390x s390x-unknown-linux-gnu YES YES
musllinux_1_2_x86_64 x86_64-unknown-linux-musl YES
musllinux_1_2_aarch64 aarch64-unknown-linux-musl YES
musllinux_1_2_ppc64le powerpc64le-unknown-linux-musl YES
win_amd64 x86_64-pc-windows-msvc YES YES YES
win_arm64 aarch64-pc-windows-msvc YES YES YES
macosx_11_0_arm64 aarch64-apple-darwin YES YES YES
macosx_10_12_x86_64 x86_64-apple-darwin YES YES YES
freebsd_14_2_release_amd64 x86_64-unknown-freebsd YES
netbsd_10_1_amd64 x86_64-unknown-netbsd YES

📒 Notes

For FreeBSD

This library supports freebsd_12_0_release or upper. Rename the distributed wheel package of setuptools-rust-bundled to the system's correct version.

For NetBSD

This library supports netbsd_9_0 or upper. Rename the distributed wheel package of setuptools-rust-bundled to the system's correct version.

For Alpine

Users should install following modules:

apk --update-cache add musl build-base python3 py3-pip

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setuptools-rust-bundled-0.1.4.tar.gz (86.5 kB view details)

Uploaded Source

File details

Details for the file setuptools-rust-bundled-0.1.4.tar.gz.

File metadata

  • Download URL: setuptools-rust-bundled-0.1.4.tar.gz
  • Upload date:
  • Size: 86.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for setuptools-rust-bundled-0.1.4.tar.gz
Algorithm Hash digest
SHA256 eb431a9145e71c0d6021e2c73b2049f08a405d9e47e7145412998b38232066eb
MD5 93b531f87b56afc249aa1b85ffa5d832
BLAKE2b-256 09cdaddf54bb1378d58fd1578163823a851769599e0e695ae5bb6bed46c1d046

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page