PyO3/maturinNew scan
86/ 100 · B

A well-known project done right. Strong docs and solid engineering throughout.

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

Rust5,648 starsApache-2.0updated 2d ago
DocumentationREADME, setup, examples, license
85
EngineeringTests, CI, linting, lockfiles
82
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  2. 2
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    Install and run instructions
    DocumentationInfo

    Add a .env.example listing all required environment variables so contributors know what to set up.

Detailed breakdown

Documentation

85
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

82
  • Tests60
    • Test files detected (test-crates/cffi-mixed/test_cffi_mixed.py).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/test.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting100
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
    • Rust linting enforced in CI: cargo clippy + cargo fmt.
    • No rustfmt.toml found.Add a rustfmt.toml to enforce a consistent code style across contributors.
  • Reproducibility80
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via Dockerfile.
    • Dockerfile uses multi-stage builds (smaller, more secure images).
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 5,648 stars.
  • Housekeeping100
    • .gitignore present.
Repository files33 root entries
  • .config
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Issue or PR templates present.
  • guide
  • maturin
  • src
  • sysconfig
  • test-crates
    Good: Licensed under Apache-2.0.
    Good: Test files detected (test-crates/cffi-mixed/test_cffi_mixed.py).
  • test-data
  • tests
  • .codespellrc
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • AGENTS.md
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • Changelog.md
    Good: CONTRIBUTING guide or docs directory present.
  • cliff.toml
  • clippy.toml
  • Code-of-Conduct.md
  • deny.toml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • license-apache
  • license-mit
  • MANIFEST.in
  • maturin.schema.json
  • netlify.toml
  • noxfile.py
  • pyproject.toml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • setup.py
  • test-dockerfile.sh