Skip to main content

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

Project description

Maturin

formerly pyo3-pack

Actions Status FreeBSD Bors enabled Crates.io PyPI Maturin User Guide Chat on Gitter

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

This project is meant as a zero configuration replacement for setuptools-rust and milksnake. It supports building wheels for python 3.5+ on windows, linux, mac and freebsd, can upload them to pypi and has basic pypy support.

Check out the User Guide!

Usage

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

pip install maturin

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 possible to upload those with twine or maturin upload.
  • 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.

pyo3 and rust-cpython bindings are automatically detected. For cffi or binaries, you need to pass -b cffi or -b bin. maturin doesn't need extra configuration files and doesn't clash with an existing setuptools-rust or milksnake 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.

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 and rust-cpython).

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, while for publishing from your repository you can use the PyO3/maturin-action github action.

pyo3 and rust-cpython

For pyo3 and rust-cpython, maturin can only build packages for installed python versions. On linux and mac, all python versions in PATH are used. If you don't set your own interpreters with -i, a heuristic is used to search for python installations. On windows all versions from the python launcher (which is installed by default by the python.org installer) and all conda environments except base are used. You can check which versions are picked up with the list-python subcommand.

pyo3 will set the used python interpreter in the environment variable PYTHON_SYS_EXECUTABLE, which can be used from custom build scripts. Maturin can build and upload wheels for pypy with pyo3, even though only pypy3.7-7.3 on linux is tested.

Cffi

Cffi wheels are compatible with all python versions including pypy. If cffi isn't installed and python is running inside a virtualenv, maturin will install it, otherwise you have to install it yourself (pip install cffi).

maturin uses cbindgen to generate a header file, which can be customized by configuring cbindgen through a cbindgen.toml file inside your project root. Alternatively you can use a build script that writes a header file to $PROJECT_ROOT/target/header.h.

Based on the header file maturin generates a module which exports an ffi and a lib object.

Example of a custom build script
use cbindgen;
use std::env;
use std::path::Path;

fn main() {
    let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap();

    let bindings = cbindgen::Builder::new()
        .with_no_includes()
        .with_language(cbindgen::Language::C)
        .with_crate(crate_dir)
        .generate()
        .unwrap();
    bindings.write_to_file(Path::new("target").join("header.h"));
}

uniffi

uniffi bindings use uniffi-rs to generate Python ctypes bindings from an interface definition file. uniffi wheels are compatible with all python versions including pypy.

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"

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/rust-cpython 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
│   └── my_project.cpython-36m-x86_64-linux-gnu.so
├── README.md
└── src
    └── lib.rs

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 take 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.0"]

Pip allows adding so called console scripts, which are shell commands that execute some function in you program. You can add console scripts in a section [project.scripts]. 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 Cargo.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>=0.14,<0.15"]
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>=0.14,<0.15"]
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.

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. 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
  • 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
  • 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
  • tantivy-py - Python bindings for Tantivy
  • 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

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.0.0b4.tar.gz (175.1 kB view details)

Uploaded Source

Built Distributions

maturin-1.0.0b4-py3-none-win_arm64.whl (5.7 MB view details)

Uploaded Python 3 Windows ARM64

maturin-1.0.0b4-py3-none-win_amd64.whl (6.6 MB view details)

Uploaded Python 3 Windows x86-64

maturin-1.0.0b4-py3-none-win32.whl (6.1 MB view details)

Uploaded Python 3 Windows x86

maturin-1.0.0b4-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl (10.0 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ s390x

maturin-1.0.0b4-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.musllinux_1_1_ppc64le.whl (8.4 MB view details)

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

maturin-1.0.0b4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_1_armv7l.whl (9.2 MB view details)

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

maturin-1.0.0b4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl (9.4 MB view details)

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

maturin-1.0.0b4-py3-none-manylinux_2_12_x86_64.manylinux2010_x86_64.musllinux_1_1_x86_64.whl (9.7 MB view details)

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

maturin-1.0.0b4-py3-none-manylinux_2_12_i686.manylinux2010_i686.musllinux_1_1_i686.whl (9.9 MB view details)

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

maturin-1.0.0b4-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl (14.9 MB view details)

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

maturin-1.0.0b4-py3-none-macosx_10_7_x86_64.whl (7.7 MB view details)

Uploaded Python 3 macOS 10.7+ x86-64

maturin-1.0.0b4-py3-none-linux_armv6l.whl (9.3 MB view details)

Uploaded Python 3

File details

Details for the file maturin-1.0.0b4.tar.gz.

File metadata

  • Download URL: maturin-1.0.0b4.tar.gz
  • Upload date:
  • Size: 175.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/0.14.14

File hashes

Hashes for maturin-1.0.0b4.tar.gz
Algorithm Hash digest
SHA256 11fbbb891794f82e138785b84bb3f8a7494fd36cafae0f233065bb8936fc1b80
MD5 e0207b3b1d988711d1a7d248dc020103
BLAKE2b-256 a049e58c50c8db245a15cfa1aa4deb1909bef509bb87fd5640a64dae8c1a9c8c

See more details on using hashes here.

File details

Details for the file maturin-1.0.0b4-py3-none-win_arm64.whl.

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 df73a353673ad405a7ddae9e865a2655a32745cfc687997dbc13b3be9777f205
MD5 f137b7b4b8765a4d66dabbde1bfe4b38
BLAKE2b-256 a131a2aac52fe7265a0cd123f5fb302983a3afd65ad0298962b23843ce8c59b5

See more details on using hashes here.

File details

Details for the file maturin-1.0.0b4-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ab5278a90644c8046ea7b7088dfd05c83853549fce6525ecf67e4cfba9e59e2b
MD5 716b386a5842363b528e5cc499281618
BLAKE2b-256 ee1896c1a5472dff95f44a671d156a3169164b142af4c77032da04432b5f01a0

See more details on using hashes here.

File details

Details for the file maturin-1.0.0b4-py3-none-win32.whl.

File metadata

  • Download URL: maturin-1.0.0b4-py3-none-win32.whl
  • Upload date:
  • Size: 6.1 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/0.14.14

File hashes

Hashes for maturin-1.0.0b4-py3-none-win32.whl
Algorithm Hash digest
SHA256 fd71524037c5f239d7b39235d5e6d255dae3bf97ad8bb1dd8a33718aa13a35e5
MD5 6da1f8bb848e96c8fcd301dbc496a1c3
BLAKE2b-256 6a1595d852aa66f5f58cceab12f9e0e96b45158dc4f2bded6c6b7c7ddc46774d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm Hash digest
SHA256 d20a5d3068033dd3257fabb98ed72bf80c3d7f61a3638d633968fe8036e5e742
MD5 80b08a5e469d736d6572dff20e5cc960
BLAKE2b-256 32069b449e526bb6a5032436d555c4c6173585d7780d5f1b160ccfb53b9bf874

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.musllinux_1_1_ppc64le.whl
Algorithm Hash digest
SHA256 c72587bcab9abba915e3b4ff0825225753e5e286af7571d6d8f7d9ab000f3a70
MD5 9d14553ce98b55bedb7355c7b3c0d081
BLAKE2b-256 5ccfdb10eea92e1f4f9f0dee4e2ed1836859d0ce3187217cf3334e587e38ccb7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_1_armv7l.whl
Algorithm Hash digest
SHA256 e3307b714417e4ce3ba1e1104c9a42c5647e577844075eacc1a9e5113ec45397
MD5 6bd0419d5c557ba24f42bf1fed42f10d
BLAKE2b-256 aecbf7ce028ce19fd2ebbe451f78436f777b4a492b0de72c174a4d2af1376970

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl
Algorithm Hash digest
SHA256 6bb6a965fa388dbd1986903b515aac198010c7a4506b4c85b0c8cfd8dfacdd03
MD5 646087d5dd1baffa28ac6a59a909681a
BLAKE2b-256 ae583cb472fad6e506241b1b2de1d7336c75896a17c92c04b0de1fea9f909b97

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-manylinux_2_12_x86_64.manylinux2010_x86_64.musllinux_1_1_x86_64.whl
Algorithm Hash digest
SHA256 296315fa629e7d65173e28dc28250b82d6f9204d3668beaf9d46a92a68a0642f
MD5 cde01af46b1fa6c9869cd5605ca82d32
BLAKE2b-256 78a16cec7a841a4809e5c6f552455b04607ae5e3477d77e078ac10d9b36decae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-manylinux_2_12_i686.manylinux2010_i686.musllinux_1_1_i686.whl
Algorithm Hash digest
SHA256 abd3c2181733f92312641ccad5450348d7f911943decf00425eb61c4dbb5fcf2
MD5 086c6efa98a98a7238dc93fec011c75b
BLAKE2b-256 d71a8bbfa0a8f5026ccbf383aca99bed14c5b05bda0eb098db91f506472614d0

See more details on using hashes here.

File details

Details for the file maturin-1.0.0b4-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 e96bc3b645c0eb6c28fcf04e425d11d54196ec77449d82ff4ab5a597969a8595
MD5 435330a86a8985c25812cc33dffc1f38
BLAKE2b-256 4210212990998ea509b15ecdda5939c6d65e8c8e361f19ff01393321182e181d

See more details on using hashes here.

File details

Details for the file maturin-1.0.0b4-py3-none-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 40c3f231d8885265f281453277b1702e483b5aaf2b1e3b415494edc89e2eb2f6
MD5 fc8599806f87d683a6224c1d4e926bf9
BLAKE2b-256 b564620caf4dae0e23a90b1ec73a4702733fbbe163afd421e2ff8cbe3d719742

See more details on using hashes here.

File details

Details for the file maturin-1.0.0b4-py3-none-linux_armv6l.whl.

File metadata

File hashes

Hashes for maturin-1.0.0b4-py3-none-linux_armv6l.whl
Algorithm Hash digest
SHA256 dc487a89a71a06f724a3d9937a2061daca1af0d5a3b20ca4f38ba32f41d279cc
MD5 44b4dd7bc952c63614916c986d5628a3
BLAKE2b-256 6df323788bb5c00b7da014c6f371c8db2a0a385cd1a8577a1def0702bc4c3cdc

See more details on using hashes here.

Supported by

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