Go to file
Anderson Bravalheri 0dc494efc5
Update README/docs to use `pyproject.toml` + separate `setup.py` docs (#356)
* Modify setup.py example to be easier to write a tutorial

* Add separated docs about setup.py usage

* Add 'docs' session to noxfile to facilitate development

* Update README to use pyproject.toml instead of setup.py

* Update building_wheels docs to avoid using setup.py

* Remove reference to setup.py in API docs

* Fix formating in example

* Fix toml syntax error in README

* Apply suggestions from code review

Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>

* Tweak README based on review

---------

Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
2023-08-24 23:01:07 +01:00
.github raise minimum python version to 3.8 and drop typing_extensions 2023-08-23 21:37:39 +00:00
docs Update README/docs to use `pyproject.toml` + separate `setup.py` docs (#356) 2023-08-24 23:01:07 +01:00
emscripten micropip install beautifulsoup4 2022-08-11 14:44:33 +08:00
examples Update README/docs to use `pyproject.toml` + separate `setup.py` docs (#356) 2023-08-24 23:01:07 +01:00
setuptools_rust Update README/docs to use `pyproject.toml` + separate `setup.py` docs (#356) 2023-08-24 23:01:07 +01:00
tests fix `get_lib_name` (#280) 2022-08-10 08:49:05 +01:00
.bumpversion.cfg release: 1.7.0 2023-08-22 18:52:03 +01:00
.gitattributes Set HTML files as vendored to fix the language in Github 2019-02-13 12:28:39 +01:00
.gitignore Replace `setuptools-scm` with bumpversion 2022-07-30 19:36:58 +08:00
.readthedocs.yaml docs: add sphinx / readthedocs configuration 2021-03-07 12:46:34 +00:00
CHANGELOG.md raise minimum python version to 3.8 and drop typing_extensions 2023-08-23 21:37:39 +00:00
LICENSE Add license file 2018-09-08 22:06:22 +02:00
MANIFEST.in Remove README.rst from MANIFEST.in 2020-12-10 16:39:00 +01:00
README.md Update README/docs to use `pyproject.toml` + separate `setup.py` docs (#356) 2023-08-24 23:01:07 +01:00
mypy.ini ci: add mypy typecheck 2021-11-28 14:06:28 +00:00
noxfile.py Update README/docs to use `pyproject.toml` + separate `setup.py` docs (#356) 2023-08-24 23:01:07 +01:00
pyproject.toml raise minimum python version to 3.8 and drop typing_extensions 2023-08-23 21:37:39 +00:00

README.md

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.

Quickstart

The following is a very basic tutorial that shows how to use setuptools-rust in pyproject.toml. It assumes that you already have a bunch of Python and Rust files that you want to distribute. You can see examples for these files in the examples/hello-world directory in the github repository. The PyO3 docs have detailed information on how to write Python modules in Rust.

hello-world
├── python
│   └── hello_world
│       └── __init__.py
└── rust
    └── lib.rs

Once the implementation files are in place, we need to add a pyproject.toml file that tells anyone that wants to use your project how to build it. In this file, we use an array of tables (TOML jargon equivalent to Python's list of dicts) for [[tool.setuptools-rust.ext-modules]], to specify different extension modules written in Rust:

# pyproject.toml
[build-system]
requires = ["setuptools", "setuptools-rust"]
build-backend = "setuptools.build_meta"

[project]
name = "hello-world"
version = "1.0"

[tool.setuptools.packages]
# Pure Python packages/modules
find = { where = ["python"] }

[[tool.setuptools-rust.ext-modules]]
# Private Rust extension module to be nested into the Python package
target = "hello_world._lib"  # The last part of the name (e.g. "_lib") has to match lib.name in Cargo.toml,
                             # but you can add a prefix to nest it inside of a Python package.
path = "Cargo.toml"      # Default value, can be omitted
binding = "PyO3"         # Default value, can be omitted
py-limited-api = "auto"  # Default value, can be omitted

Each extension module should map directly into the corresponding [lib] table on the Cargo manifest file:

# Cargo.toml
[package]
name = "hello-world"
version = "0.1.0"
edition = "2018"

[dependencies]
pyo3 = { version = "0.19.2", features = ["extension-module"] }

[lib]
name = "_lib"  # private module to be nested into Python package,
               # needs to match the name of the function with the `[#pymodule]` attribute
path = "rust/lib.rs"
crate-type = ["cdylib"]  # required for shared library for Python to import from.

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
# See also PyO3 docs on writing Cargo.toml files at https://pyo3.rs

You will also need to tell Setuptools that the Rust files are required to build your project from the source distribution. That can be done either via MANIFEST.in (see example below) or via a plugin like setuptools-scm.

# MANIFEST.in
include Cargo.toml
recursive-include rust *.rs

With these files in place, you can install the project in a virtual environment for testing and making sure everything is working correctly:

# cd hello-world
python3 -m venv .venv
source .venv/bin/activate  # on Linux or macOS
.venv\Scripts\activate     # on Windows
python -m pip install -e .
python
>>> import hello_world
# ... try running something from your new extension module ...
# ... better write some tests with pytest ...

Next steps and final remarks

  • When you are ready to distribute your project, have a look on 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.

  • You can also use [[tool.setuptools-rust.bins]] (instead of [[tool.setuptools-rust.ext-modules]]), if you want to distribute a binary executable written in Rust (instead of a library that can be imported by the Python runtime). Note however that distributing both library and executable (or multiple executables), may significantly increase the size of the wheel file distributed by the package index and therefore increase build, download and installation times. Another approach is to use a Python entry-point that calls the Rust implementation (exposed via PyO3 bindings). See the hello-world example for more insights.

  • For a complete reference of the configuration options, see the API reference. You can use any parameter defined by the RustExtension class with [[tool.setuptools-rust.ext-modules]] and any parameter defined by the RustBin class with [[tool.setuptools-rust.bins]]; just remember to replace underscore characters _ with dashes - in your pyproject.toml file.

  • Cargo.toml allow only one [lib] table per file. If you require multiple extension modules you will need to write multiple Cargo.toml files. Alternatively you can create a single private Rust top-level module that exposes multiple submodules (using PyO3's submodules), which may also reduce the size of the build artifacts. You can always keep your extension modules private and wrap them in pure Python to have fine control over the public API.

  • If want to include both [[tool.setuptools-rust.bins]] and [[tool.setuptools-rust.ext-modules]] in the same macOS wheel, you might have to manually add an extra build.rs file, see PyO3/setuptools-rust#351 for more information about the workaround.

  • For more examples, see:

    • hello-world: a more complete version of the code used in this tutorial that mixes both [[tool.setuptools-rust.ext-modules]] and [[tool.setuptools-rust.bins]] in a single distribution.
    • html-py-ever: a more advanced example that uses Rust crates as dependencies.
    • rust_with_cffi: uses both Rust and CFFI.
    • namespace_package: integrates Rust-written modules into PEP 420 namespace packages.
    • hello-world-script: uses Rust only for creating binary executables, not library modules.