{"author":"konstin , messense ","author_email":"konstin ","bugtrack_url":null,"classifiers":["Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Programming Language :: Rust","Topic :: Software Development :: Build Tools"],"description":"# Maturin\n\n_formerly pyo3-pack_\n\n[![Maturin User Guide](https://img.shields.io/badge/user-guide-brightgreen?logo=readthedocs&style=flat-square)](https://maturin.rs)\n[![Crates.io](https://img.shields.io/crates/v/maturin.svg?logo=rust&style=flat-square)](https://crates.io/crates/maturin)\n[![PyPI](https://img.shields.io/pypi/v/maturin.svg?logo=python&style=flat-square)](https://pypi.org/project/maturin)\n[![discord server](https://img.shields.io/discord/1209263839632424990?logo=discord&style=flat-square)](https://discord.gg/33kcChzH7f)\n\nBuild and publish crates with [pyo3, cffi and uniffi bindings](https://maturin.rs/bindings) as well as rust binaries as python packages with minimal configuration.\nIt supports building wheels for python 3.8+ on Windows, Linux, macOS and FreeBSD, can upload them to [pypi](https://pypi.org/) and has basic PyPy and GraalPy support.\n\nCheck out the [User Guide](https://maturin.rs/)!\n\n## Usage\n\nYou can either download binaries from the [latest release](https://github.com/PyO3/maturin/releases/latest) or install it with [pipx](https://pypa.github.io/pipx/) or [uv](https://github.com/astral-sh/uv):\n\n```shell\n# pipx\npipx install maturin\n# uv\nuv tool install maturin\n```\n\n> [!NOTE]\n>\n> `pip install maturin` should also work if you don't want to use pipx.\n\nThere are four main commands:\n\n- `maturin new` creates a new cargo project with maturin configured.\n- `maturin publish` builds the crate into python packages and publishes them to pypi.\n- `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](https://github.com/astral-sh/uv) using `uv publish`.\n- `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.\n\nmaturin doesn't need extra configuration files and doesn't clash with an existing setuptools-rust configuration.\nYou can even integrate it with testing tools such as [tox](https://tox.readthedocs.io/en/latest/).\nThere are examples for the different bindings in the `test-crates` folder.\n\nThe name of the package will be the name of the cargo project, i.e. the name field in the `[package]` section of `Cargo.toml`.\nThe 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.\n\nWhen using `maturin build` and `maturin develop` commands, you can compile a performance-optimized program by adding the `-r` or `--release` flag.\n\n## Python packaging basics\n\nPython packages come in two formats:\nA built form called wheel and source distributions (sdist), both of which are archives.\nA wheel can be compatible with any python version, interpreter (cpython and pypy, mainly), operating system and hardware architecture (for pure python wheels),\ncan 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).\n\nWhen 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,\nwhich requires the right compilers to be installed. Installing a wheel is much faster than installing a source distribution as building wheels is generally slow.\n\nWhen you publish a package to be installable with `pip install`, you upload it to [pypi](https://pypi.org/), the official package repository.\nFor testing, you can use [test pypi](https://test.pypi.org/) instead, which you can use with `pip install --index-url https://test.pypi.org/simple/`.\nNote that for [publishing for linux](#manylinux-and-auditwheel), you need to use the manylinux docker container or zig, while for publishing from your repository you can use the [PyO3/maturin-action](https://github.com/PyO3/maturin-action) github action.\n\n## Mixed rust/python projects\n\nTo 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:\n\n```\nmy-project\n├── Cargo.toml\n├── my_project\n│ ├── __init__.py\n│ └── bar.py\n├── pyproject.toml\n├── README.md\n└── src\n └── lib.rs\n```\n\nYou can specify a different python source directory in `pyproject.toml` by setting `tool.maturin.python-source`, for example\n\n**pyproject.toml**\n\n```toml\n[tool.maturin]\npython-source = \"python\"\nmodule-name = \"my_project._lib_name\"\n```\n\nthen the project structure would look like this:\n\n```\nmy-project\n├── Cargo.toml\n├── python\n│ └── my_project\n│ ├── __init__.py\n│ └── bar.py\n├── pyproject.toml\n├── README.md\n└── src\n └── lib.rs\n```\n\n> [!NOTE]\n>\n> This structure is recommended to avoid [a common `ImportError` pitfall](https://github.com/PyO3/maturin/issues/490)\n\nmaturin 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.\n\nWith 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`.\n\nExample layout with pyo3 after `maturin develop`:\n\n```\nmy-project\n├── Cargo.toml\n├── my_project\n│ ├── __init__.py\n│ ├── bar.py\n│ └── _lib_name.cpython-36m-x86_64-linux-gnu.so\n├── README.md\n└── src\n └── lib.rs\n```\n\nWhen 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):\n\n```rust\n#[pymodule]\n#[pyo3(name=\"_lib_name\")]\nfn my_lib_name(m: &Bound<'_, PyModule>) -> PyResult<()> {\n m.add_class::()?;\n Ok(())\n}\n```\n\n## Python metadata\n\nmaturin supports [PEP 621](https://www.python.org/dev/peps/pep-0621/), you can specify python package metadata in `pyproject.toml`.\nmaturin merges metadata from `Cargo.toml` and `pyproject.toml`, `pyproject.toml` takes precedence over `Cargo.toml`.\n\nTo specify python dependencies, add a list `dependencies` in a `[project]` section in the `pyproject.toml`. This list is equivalent to `install_requires` in setuptools:\n\n```toml\n[project]\nname = \"my-project\"\ndependencies = [\"flask~=1.1.0\", \"toml>=0.10.2,<0.11.0\"]\n```\n\nYou can add so called console scripts, which are shell commands that execute some function in your program in the `[project.scripts]` section.\nThe 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:\n\n```toml\n[project.scripts]\nget_42 = \"my_project:DummyClass.get_42\"\n```\n\nYou can also specify [trove classifiers](https://pypi.org/classifiers/) in your `pyproject.toml` under `project.classifiers`:\n\n```toml\n[project]\nname = \"my-project\"\nclassifiers = [\"Programming Language :: Python\"]\n```\n\n## Source distribution\n\nmaturin supports building through `pyproject.toml`. To use it, create a `pyproject.toml` next to your `Cargo.toml` with the following content:\n\n```toml\n[build-system]\nrequires = [\"maturin>=1.0,<2.0\"]\nbuild-backend = \"maturin\"\n```\n\nIf a `pyproject.toml` with a `[build-system]` entry is present, maturin can build a source distribution of your package when `--sdist` is specified.\nThe source distribution will contain the same files as `cargo package`. To only build a source distribution, pass `--interpreter` without any values.\n\nYou can then e.g. install your package with `pip install .`. With `pip install . -v` you can see the output of cargo and maturin.\n\nYou 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.\nThe `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](https://discuss.python.org/t/pep-517-debug-vs-release-builds/1924) for details).\n\nFor a non-manylinux build with cffi bindings you could use the following:\n\n```toml\n[build-system]\nrequires = [\"maturin>=1.0,<2.0\"]\nbuild-backend = \"maturin\"\n\n[tool.maturin]\nbindings = \"cffi\"\ncompatibility = \"linux\"\n```\n\n`manylinux` option is also accepted as an alias of `compatibility` for backward compatibility with old version of maturin.\n\nTo include arbitrary files in the sdist for use during compilation specify `include` as an array of `path` globs with `format` set to `sdist`:\n\n```toml\n[tool.maturin]\ninclude = [{ path = \"path/**/*\", format = \"sdist\" }]\n```\n\nThere's a `maturin sdist` command for only building a source distribution as workaround for [pypa/pip#6041](https://github.com/pypa/pip/issues/6041).\n\n## Manylinux and auditwheel\n\nFor 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.\nThe pypa offers special docker images and a tool called [auditwheel](https://github.com/pypa/auditwheel/) to ensure compliance with the [manylinux rules](https://peps.python.org/pep-0599/#the-manylinux2014-policy).\nIf you want to publish widely usable wheels for linux pypi, **you need to use a manylinux docker image or build with zig**.\n\nThe Rust compiler since version 1.64 [requires at least glibc 2.17](https://blog.rust-lang.org/2022/08/01/Increasing-glibc-kernel-requirements.html), so you need to use at least manylinux2014.\nFor 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`.\nThe [PyO3/maturin-action](https://github.com/PyO3/maturin-action) github action already takes care of this if you set e.g. `manylinux: 2014`.\n\nmaturin contains a reimplementation of auditwheel automatically checks the generated library and gives the wheel the proper platform tag.\nIf your system's glibc is too new or you link other shared libraries, it will assign the `linux` tag.\nYou can also manually disable those checks and directly use native linux target with `--manylinux off`.\n\nFor full manylinux compliance you need to compile in a CentOS docker container. The [pyo3/maturin](https://ghcr.io/pyo3/maturin) image is based on the manylinux2014 image,\nand passes arguments to the `maturin` binary. You can use it like this:\n\n```\ndocker run --rm -v $(pwd):/io ghcr.io/pyo3/maturin build --release # or other maturin arguments\n```\n\nNote 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.\nSee [konstin/complex-manylinux-maturin-docker](https://github.com/konstin/complex-manylinux-maturin-docker) for a small educational example or [nanoporetech/fast-ctc-decode](https://github.com/nanoporetech/fast-ctc-decode/blob/b226ea0f2b2f4f474eff47349703d57d2ea4801b/.github/workflows/publish.yml) for a real world setup.\n\nmaturin itself is manylinux compliant when compiled for the musl target.\n\n## Examples\n\n- [ballista-python](https://github.com/apache/arrow-ballista-python) - A Python library that binds to Apache Arrow distributed query engine Ballista\n- [bleuscore](https://github.com/shenxiangzhuang/bleuscore) - A BLEU score calculation library, written in pure Rust\n- [chardetng-py](https://github.com/john-parton/chardetng-py) - Python binding for the chardetng character encoding detector.\n- [connector-x](https://github.com/sfu-db/connector-x/tree/main/connectorx-python) - ConnectorX enables you to load data from databases into Python in the fastest and most memory efficient way\n- [datafusion-python](https://github.com/apache/arrow-datafusion-python) - a Python library that binds to Apache Arrow in-memory query engine DataFusion\n- [deltalake-python](https://github.com/delta-io/delta-rs/tree/main/python) - Native Delta Lake Python binding based on delta-rs with Pandas integration\n- [opendal](https://github.com/apache/incubator-opendal/tree/main/bindings/python) - OpenDAL Python Binding to access data freely\n- [orjson](https://github.com/ijl/orjson) - A fast, correct JSON library for Python\n- [polars](https://github.com/pola-rs/polars/tree/master/py-polars) - Fast multi-threaded DataFrame library in Rust | Python | Node.js\n- [pydantic-core](https://github.com/pydantic/pydantic-core) - Core validation logic for pydantic written in Rust\n- [pyrus-cramjam](https://github.com/milesgranger/pyrus-cramjam) - Thin Python wrapper to de/compression algorithms in Rust\n- [pyxel](https://github.com/kitao/pyxel) - A retro game engine for Python\n- [roapi](https://github.com/roapi/roapi) - ROAPI automatically spins up read-only APIs for static datasets without requiring you to write a single line of code\n- [robyn](https://github.com/sansyrox/robyn) - A fast and extensible async python web server with a Rust runtime\n- [ruff](https://github.com/charliermarsh/ruff) - An extremely fast Python linter, written in Rust\n- [rnet](https://github.com/0x676e67/rnet) - Asynchronous Python HTTP Client with Black Magic\n- [rustpy-xlsxwriter](https://github.com/rahmadafandi/rustpy-xlsxwriter): A high-performance Python library for generating Excel files, utilizing the [rust_xlsxwriter](https://github.com/jmcnamara/rust_xlsxwriter) crate for efficient data handling.\n- [tantivy-py](https://github.com/quickwit-oss/tantivy-py) - Python bindings for Tantivy\n- [tpchgen-cli](https://github.com/clflushopt/tpchgen-rs/tree/main/tpchgen-cli) - Python CLI binding for `tpchgen`, a blazing fast TPC-H benchmark data generator built in pure Rust with zero dependencies.\n- [watchfiles](https://github.com/samuelcolvin/watchfiles) - Simple, modern and high performance file watching and code reload in python\n- [wonnx](https://github.com/webonnx/wonnx/tree/master/wonnx-py) - Wonnx is a GPU-accelerated ONNX inference run-time written 100% in Rust\n\n## Contributing\n\nEveryone is welcomed to contribute to maturin! There are many ways to support the project, such as:\n\n- help maturin users with issues on GitHub and Gitter\n- improve documentation\n- write features and bugfixes\n- publish blogs and examples of how to use maturin\n\nOur [contributing notes](https://github.com/PyO3/maturin/blob/main/guide/src/contributing.md) have more resources if you wish to volunteer time for maturin and are searching where to start.\n\nIf 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:\n\n- [messense](https://github.com/sponsors/messense)\n\n## License\n\nLicensed under either of:\n\n- Apache License, Version 2.0, ([LICENSE-APACHE](https://github.com/PyO3/maturin/blob/main/license-apache) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](https://github.com/PyO3/maturin/blob/main/license-mit) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/pyo3/maturin","keywords":"python, cffi, packaging, pypi, pyo3","license":"MIT OR Apache-2.0","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"maturin","package_url":"https://pypi.org/project/maturin/","platform":null,"project_url":"https://pypi.org/project/maturin/","project_urls":{"Changelog":"https://maturin.rs/changelog.html","Documentation":"https://maturin.rs","Homepage":"https://github.com/pyo3/maturin","Issues":"https://github.com/PyO3/maturin/issues","Source Code":"https://github.com/PyO3/maturin"},"provides_extra":null,"release_url":"https://pypi.org/project/maturin/1.8.6/","requires_dist":["tomli>=1.1.0; python_full_version < \"3.11\"","ziglang<0.13.0,>=0.10.0; extra == \"zig\"","patchelf; extra == \"patchelf\""],"requires_python":">=3.7","summary":"Build and publish crates with pyo3, cffi and uniffi bindings as well as rust binaries as python packages","version":"1.8.6","yanked":false,"yanked_reason":null}

Dependencies of maturin (3).
Dependency	Optional
tomli	false
patchelf	true
ziglang	true

Package search

maturin

project_urls

Dependencies

All package metadata

Releases