Skip to main content

Setuptools Rust extension plugin

Project description

Setuptools plugin for Rust extensions

github actions pypi package readthedocs code style: black

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-cross-compile 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.

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-1.3.0.tar.gz (285.7 kB view details)

Uploaded Source

Built Distribution

setuptools_rust-1.3.0-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file setuptools-rust-1.3.0.tar.gz.

File metadata

  • Download URL: setuptools-rust-1.3.0.tar.gz
  • Upload date:
  • Size: 285.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for setuptools-rust-1.3.0.tar.gz
Algorithm Hash digest
SHA256 958c5bf4ab6483d59dab888538121871cc5006354a42fb0fbd50acf03caad1de
MD5 9760ac511ebe33c759b76efb0a1299dd
BLAKE2b-256 a9555db4a5b137af2afdc23a6e251d5ebb3b4e04c8deb68fbb5ffdacbd134c0c

See more details on using hashes here.

File details

Details for the file setuptools_rust-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for setuptools_rust-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ead7398d6b6fe70a7743408dc2f7257dbcb8ca9b2d7a9f8b281c09bd86f36a5
MD5 2c8f3dd72c03026795df6693dd665fe4
BLAKE2b-256 be19a9356aac40b2432cd159264be98843af062877ff27422cdd7cf023828835

See more details on using hashes here.

Supported by

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