Skip to main content

Build and publish crates with pyo3, cffi and uniffi bindings as well as rust binaries as python packages

Project description

Maturin

formerly pyo3-pack

Maturin User Guide Crates.io PyPI discord server

Build and publish crates with pyo3, cffi and uniffi bindings as well as rust binaries as python packages with minimal configuration. It supports building wheels for python 3.8+ on Windows, Linux, macOS and FreeBSD, can upload them to pypi and has basic PyPy and GraalPy support.

Check out the User Guide!

Usage

You can either download binaries from the latest release or install it with pipx or uv:

# pipx
pipx install maturin
# uv
uv tool install maturin

[!NOTE]

pip install maturin should also work if you don't want to use pipx.

There are four main commands:

  • maturin new creates a new cargo project with maturin configured.
  • maturin publish builds the crate into python packages and publishes them to pypi.
  • maturin build builds the wheels and stores them in a folder (target/wheels by default), but doesn't upload them. It's recommended to publish packages with uv using uv publish.
  • maturin develop builds the crate and installs it as a python module directly in the current virtualenv. Note that while maturin develop is faster, it doesn't support all the feature that running pip install after maturin build supports.

maturin doesn't need extra configuration files and doesn't clash with an existing setuptools-rust configuration. You can even integrate it with testing tools such as tox. There are examples for the different bindings in the test-crates folder.

The name of the package will be the name of the cargo project, i.e. the name field in the [package] section of Cargo.toml. The name of the module, which you are using when importing, will be the name value in the [lib] section (which defaults to the name of the package). For binaries, it's simply the name of the binary generated by cargo.

When using maturin build and maturin develop commands, you can compile a performance-optimized program by adding the -r or --release flag.

Python packaging basics

Python packages come in two formats: A built form called wheel and source distributions (sdist), both of which are archives. A wheel can be compatible with any python version, interpreter (cpython and pypy, mainly), operating system and hardware architecture (for pure python wheels), can be limited to a specific platform and architecture (e.g. when using ctypes or cffi) or to a specific python interpreter and version on a specific architecture and operating system (e.g. with pyo3).

When using pip install on a package, pip tries to find a matching wheel and install that. If it doesn't find one, it downloads the source distribution and builds a wheel for the current platform, which requires the right compilers to be installed. Installing a wheel is much faster than installing a source distribution as building wheels is generally slow.

When you publish a package to be installable with pip install, you upload it to pypi, the official package repository. For testing, you can use test pypi instead, which you can use with pip install --index-url https://test.pypi.org/simple/. Note that for publishing for linux, you need to use the manylinux docker container or zig, while for publishing from your repository you can use the PyO3/maturin-action github action.

Mixed rust/python projects

To create a mixed rust/python project, create a folder with your module name (i.e. lib.name in Cargo.toml) next to your Cargo.toml and add your python sources there:

my-project
├── Cargo.toml
├── my_project
│   ├── __init__.py
│   └── bar.py
├── pyproject.toml
├── README.md
└── src
    └── lib.rs

You can specify a different python source directory in pyproject.toml by setting tool.maturin.python-source, for example

pyproject.toml

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

then the project structure would look like this:

my-project
├── Cargo.toml
├── python
│   └── my_project
│       ├── __init__.py
│       └── bar.py
├── pyproject.toml
├── README.md
└── src
    └── lib.rs

[!NOTE]

This structure is recommended to avoid a common ImportError pitfall

maturin will add the native extension as a module in your python folder. When using develop, maturin will copy the native library and for cffi also the glue code to your python folder. You should add those files to your gitignore.

With cffi you can do from .my_project import lib and then use lib.my_native_function, with pyo3 you can directly from .my_project import my_native_function.

Example layout with pyo3 after maturin develop:

my-project
├── Cargo.toml
├── my_project
│   ├── __init__.py
│   ├── bar.py
│   └── _lib_name.cpython-36m-x86_64-linux-gnu.so
├── README.md
└── src
    └── lib.rs

When doing this also be sure to set the module name in your code to match the last part of module-name (don't include the package path):

#[pymodule]
#[pyo3(name="_lib_name")]
fn my_lib_name(m: &Bound<'_, PyModule>) -> PyResult<()> {
    m.add_class::<MyPythonRustClass>()?;
    Ok(())
}

Python metadata

maturin supports PEP 621, you can specify python package metadata in pyproject.toml. maturin merges metadata from Cargo.toml and pyproject.toml, pyproject.toml takes precedence over Cargo.toml.

To specify python dependencies, add a list dependencies in a [project] section in the pyproject.toml. This list is equivalent to install_requires in setuptools:

[project]
name = "my-project"
dependencies = ["flask~=1.1.0", "toml>=0.10.2,<0.11.0"]

You can add so called console scripts, which are shell commands that execute some function in your program in the [project.scripts] section. The keys are the script names while the values are the path to the function in the format some.module.path:class.function, where the class part is optional. The function is called with no arguments. Example:

[project.scripts]
get_42 = "my_project:DummyClass.get_42"

You can also specify trove classifiers in your pyproject.toml under project.classifiers:

[project]
name = "my-project"
classifiers = ["Programming Language :: Python"]

Source distribution

maturin supports building through pyproject.toml. To use it, create a pyproject.toml next to your Cargo.toml with the following content:

[build-system]
requires = ["maturin>=1.0,<2.0"]
build-backend = "maturin"

If a pyproject.toml with a [build-system] entry is present, maturin can build a source distribution of your package when --sdist is specified. The source distribution will contain the same files as cargo package. To only build a source distribution, pass --interpreter without any values.

You can then e.g. install your package with pip install .. With pip install . -v you can see the output of cargo and maturin.

You can use the options compatibility, skip-auditwheel, bindings, strip and common Cargo build options such as features under [tool.maturin] the same way you would when running maturin directly. The bindings key is required for cffi and bin projects as those can't be automatically detected. Currently, all builds are in release mode (see this thread for details).

For a non-manylinux build with cffi bindings you could use the following:

[build-system]
requires = ["maturin>=1.0,<2.0"]
build-backend = "maturin"

[tool.maturin]
bindings = "cffi"
compatibility = "linux"

manylinux option is also accepted as an alias of compatibility for backward compatibility with old version of maturin.

To include arbitrary files in the sdist for use during compilation specify include as an array of path globs with format set to sdist:

[tool.maturin]
include = [{ path = "path/**/*", format = "sdist" }]

There's a maturin sdist command for only building a source distribution as workaround for pypa/pip#6041.

Manylinux and auditwheel

For portability reasons, native python modules on linux must only dynamically link a set of very few libraries which are installed basically everywhere, hence the name manylinux. The pypa offers special docker images and a tool called auditwheel to ensure compliance with the manylinux rules. If you want to publish widely usable wheels for linux pypi, you need to use a manylinux docker image or build with zig.

The Rust compiler since version 1.64 requires at least glibc 2.17, so you need to use at least manylinux2014. For publishing, we recommend enforcing the same manylinux version as the image with the manylinux flag, e.g. use --manylinux 2014 if you are building in quay.io/pypa/manylinux2014_x86_64. The PyO3/maturin-action github action already takes care of this if you set e.g. manylinux: 2014.

maturin contains a reimplementation of auditwheel automatically checks the generated library and gives the wheel the proper platform tag. If your system's glibc is too new or you link other shared libraries, it will assign the linux tag. You can also manually disable those checks and directly use native linux target with --manylinux off.

For full manylinux compliance you need to compile in a CentOS docker container. The pyo3/maturin image is based on the manylinux2014 image, and passes arguments to the maturin binary. You can use it like this:

docker run --rm -v $(pwd):/io ghcr.io/pyo3/maturin build --release  # or other maturin arguments

Note that this image is very basic and only contains python, maturin and stable rust. If you need additional tools, you can run commands inside the manylinux container. See konstin/complex-manylinux-maturin-docker for a small educational example or nanoporetech/fast-ctc-decode for a real world setup.

maturin itself is manylinux compliant when compiled for the musl target.

Examples

  • ballista-python - A Python library that binds to Apache Arrow distributed query engine Ballista
  • bleuscore - A BLEU score calculation library, written in pure Rust
  • chardetng-py - Python binding for the chardetng character encoding detector.
  • connector-x - ConnectorX enables you to load data from databases into Python in the fastest and most memory efficient way
  • datafusion-python - a Python library that binds to Apache Arrow in-memory query engine DataFusion
  • deltalake-python - Native Delta Lake Python binding based on delta-rs with Pandas integration
  • opendal - OpenDAL Python Binding to access data freely
  • orjson - A fast, correct JSON library for Python
  • polars - Fast multi-threaded DataFrame library in Rust | Python | Node.js
  • pydantic-core - Core validation logic for pydantic written in Rust
  • pyrus-cramjam - Thin Python wrapper to de/compression algorithms in Rust
  • pyxel - A retro game engine for Python
  • roapi - ROAPI automatically spins up read-only APIs for static datasets without requiring you to write a single line of code
  • robyn - A fast and extensible async python web server with a Rust runtime
  • ruff - An extremely fast Python linter, written in Rust
  • rnet - Asynchronous Python HTTP Client with Black Magic
  • rustpy-xlsxwriter: A high-performance Python library for generating Excel files, utilizing the rust_xlsxwriter crate for efficient data handling.
  • tantivy-py - Python bindings for Tantivy
  • tpchgen-cli - Python CLI binding for tpchgen, a blazing fast TPC-H benchmark data generator built in pure Rust with zero dependencies.
  • watchfiles - Simple, modern and high performance file watching and code reload in python
  • wonnx - Wonnx is a GPU-accelerated ONNX inference run-time written 100% in Rust

Contributing

Everyone is welcomed to contribute to maturin! There are many ways to support the project, such as:

  • help maturin users with issues on GitHub and Gitter
  • improve documentation
  • write features and bugfixes
  • publish blogs and examples of how to use maturin

Our contributing notes have more resources if you wish to volunteer time for maturin and are searching where to start.

If you don't have time to contribute yourself but still wish to support the project's future success, some of our maintainers have GitHub sponsorship pages:

License

Licensed under either of:

at your option.

Project details


Release history Release notifications | RSS feed

This version

1.9.1

Download files

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

Source Distribution

maturin-1.9.1.tar.gz (209.8 kB view details)

Uploaded Source

Built Distributions

maturin-1.9.1-py3-none-win_arm64.whl (6.9 MB view details)

Uploaded Python 3Windows ARM64

maturin-1.9.1-py3-none-win_amd64.whl (8.3 MB view details)

Uploaded Python 3Windows x86-64

maturin-1.9.1-py3-none-win32.whl (7.3 MB view details)

Uploaded Python 3Windows x86

maturin-1.9.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl (8.9 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ s390x

maturin-1.9.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.musllinux_1_1_ppc64le.whl (10.6 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ppc64lemusllinux: musl 1.1+ ppc64le

maturin-1.9.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_1_armv7l.whl (8.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARMv7lmusllinux: musl 1.1+ ARMv7l

maturin-1.9.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl (8.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64musllinux: musl 1.1+ ARM64

maturin-1.9.1-py3-none-manylinux_2_12_x86_64.manylinux2010_x86_64.musllinux_1_1_x86_64.whl (8.8 MB view details)

Uploaded Python 3manylinux: glibc 2.12+ x86-64musllinux: musl 1.1+ x86-64

maturin-1.9.1-py3-none-manylinux_2_12_i686.manylinux2010_i686.musllinux_1_1_i686.whl (8.3 MB view details)

Uploaded Python 3manylinux: glibc 2.12+ i686musllinux: musl 1.1+ i686

maturin-1.9.1-py3-none-macosx_10_12_x86_64.whl (8.4 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

maturin-1.9.1-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (16.1 MB view details)

Uploaded Python 3macOS 10.12+ universal2 (ARM64, x86-64)macOS 10.12+ x86-64macOS 11.0+ ARM64

maturin-1.9.1-py3-none-linux_armv6l.whl (8.3 MB view details)

Uploaded Python 3

File details

Details for the file maturin-1.9.1.tar.gz.

File metadata

  • Download URL: maturin-1.9.1.tar.gz
  • Upload date:
  • Size: 209.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.0

File hashes

Hashes for maturin-1.9.1.tar.gz
Algorithm Hash digest
SHA256 97b52fb19d20c1fdc70e4efdc05d79853a4c9c0051030c93a793cd5181dc4ccd
MD5 9a01ee3ea7fa8dd82467fc1c73bf2868
BLAKE2b-256 94f773cf2ae0d6db943a627d28c09f5368735fce6b8b2ad1e1f6bcda2632c80a

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-win_arm64.whl.

File metadata

  • Download URL: maturin-1.9.1-py3-none-win_arm64.whl
  • Upload date:
  • Size: 6.9 MB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.0

File hashes

Hashes for maturin-1.9.1-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 0e6e2ddc83999ac3999576b06649a327536a51d57c917fa01416e40f53106bda
MD5 adbec70e2e512983312759208b40e15f
BLAKE2b-256 063d74e75874b75fc82e4774f2ed78ad546fda3e127bae4a971db3611bdab285

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-win_amd64.whl.

File metadata

  • Download URL: maturin-1.9.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 8.3 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.0

File hashes

Hashes for maturin-1.9.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c8b71cf0f6a5f712ac1466641d520e2ce3fbe44104319a55d875cc8326dcdd61
MD5 a01b70ef58631010ca06cf464197ad8f
BLAKE2b-256 a607c99058a73d0f7d8e8c87bf60c48a96c44f42ff4ef6a6ae4ca3821605bdd2

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-win32.whl.

File metadata

  • Download URL: maturin-1.9.1-py3-none-win32.whl
  • Upload date:
  • Size: 7.3 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.9.0

File hashes

Hashes for maturin-1.9.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 69d9f752f33a3c95062014f464cbd715e83a175f4601b76a9ce3db6ea18df976
MD5 ab85a4dcd809d735a8f7e8bce694b03b
BLAKE2b-256 595f97ff670cb718a40ee21faf38e07e0d773573180de98ee453142e5f932052

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 f5dde6fbcc36a1173fe74e6629fee36e89df76236247b64b23055f1f820bdf35
MD5 60ef9b69f35e1a999be2e9f5bffcb075
BLAKE2b-256 24ad7f8a9d8a1b79c2ed6291aaaa22147c98efee729b23df2803c319dd658049

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.musllinux_1_1_ppc64le.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.musllinux_1_1_ppc64le.whl
Algorithm Hash digest
SHA256 e0a2c546c123ed97d1ee0c9cc80a912d9174913643c737c12adf4bce46603bb3
MD5 1bdca89124fd30f458a2b3a2cd541c51
BLAKE2b-256 2fa6be684b4fce58f8b3a9d3b701c23961d5fe0e1710ed484e2216441997e74f

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_1_armv7l.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_1_armv7l.whl
Algorithm Hash digest
SHA256 7c26fb60d80e6a72a8790202bb14dbef956b831044f55d1ce4e2c2e915eb6124
MD5 47d090e2cace7946c08e8f1da6aa5f58
BLAKE2b-256 9545770fc005bceac81f5905c96f37c36f65fa9c3da3f4aa8d4e4d2a883aa967

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl
Algorithm Hash digest
SHA256 9d037a37b8ef005eebdea61eaf0e3053ebcad3b740162932fbc120db5fdf5653
MD5 0c7b571889d35638d9c6569a4432362a
BLAKE2b-256 72d8b97f4767786eae63bb6b700b342766bcea88da98796bfee290bcddd99fd8

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-manylinux_2_12_x86_64.manylinux2010_x86_64.musllinux_1_1_x86_64.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-manylinux_2_12_x86_64.manylinux2010_x86_64.musllinux_1_1_x86_64.whl
Algorithm Hash digest
SHA256 e7eb54db3aace213420cd545b24a149842e8d6b1fcec046d0346f299d8adfc34
MD5 16b6bda3dfac0d1ddb1ccd9f1e80e9a5
BLAKE2b-256 e05bb15ad53e1e6733d8798ce903d25d9e05aa3083b2544f1a6f863ea01dd50d

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-manylinux_2_12_i686.manylinux2010_i686.musllinux_1_1_i686.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-manylinux_2_12_i686.manylinux2010_i686.musllinux_1_1_i686.whl
Algorithm Hash digest
SHA256 2f05f07bc887e010c44d32a088aea4f36a2104e301f51f408481e4e9759471a7
MD5 976d80d2e3e9a042968e92b1881c52bf
BLAKE2b-256 d9274b29614964c10370effcdfcf34ec57126c9a4b921b7a2c42a94ae3a59cb0

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e14eedbc4369dda1347ce9ddc183ade7c513d9975b7ea2b9c9e4211fb74f597a
MD5 c87f1a028a0630acad1bbf69b25f149d
BLAKE2b-256 c4404e0da87e563333ff1605fef15bed5858c2a41c0c0404e47f20086f214473

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 6a9c9d176f6df3a8ec1a4c9c72c8a49674ed13668a03c9ead5fab983bbeeb624
MD5 c86f60e89639b1258803f1507af63777
BLAKE2b-256 b87236966375c2c2bb2d66df4fa756cfcd54175773719b98d4b26a6b4d1f0bfc

See more details on using hashes here.

File details

Details for the file maturin-1.9.1-py3-none-linux_armv6l.whl.

File metadata

File hashes

Hashes for maturin-1.9.1-py3-none-linux_armv6l.whl
Algorithm Hash digest
SHA256 fe8f59f9e387fb19635eab6b7381ef718e5dc7a328218e6da604c91f206cbb72
MD5 cc90bef104fb2465e826db9843d59652
BLAKE2b-256 48f2de43e8954092bd957fbdfbc5b978bf8be40f27aec1a4ebd65e57cfb3ec8a

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