ruff-odoo

ruff-odoo is Vauxoo's fork of Ruff, shipping every upstream linter and formatter rule plus the OD and OAPP rule groups, ported from pylint-odoo and odoo-pre-commit-hooks.

The Odoo rules, how to enable them, and how to migrate from pylint-odoo: https://vauxoo.github.io/ruff-odoo/
Everything else — configuration, the formatter, editor integrations, the upstream rules — behaves exactly as upstream and is documented at https://docs.astral.sh/ruff/.

This file covers what differs from upstream Ruff for anyone installing or building the fork: the command name, the packaging, and the version scheme.

The `ruff-odoo` command

The published command is ruff-odoo, not ruff. It is the exact same CLI, only under a name that cannot collide with an upstream ruff installation, so both can live in the same environment:

$ ruff-odoo check   # Lint all files in the current directory.
$ ruff-odoo format  # Format all files in the current directory.

The Python module is ruff_odoo, so the CLI is also reachable without the console script:

$ python -m ruff_odoo check

Installation

The package is published to PyPI as ruff-odoo. It is not distributed through Homebrew, conda, Docker, or the standalone astral.sh installers — those channels ship upstream Ruff only.

$ # Run it without installing.
$ uvx ruff-odoo check

$ # Install it globally.
$ uv tool install ruff-odoo@latest

$ # Or add it to your project.
$ uv add --dev ruff-odoo

$ # With pip.
$ pip install ruff-odoo

Installing ruff-odoo alongside the upstream ruff package is supported, even in the same environment: ruff-odoo owns the ruff-odoo entry point and never touches ruff.

pre-commit

Use the mirror repository, which installs the prebuilt wheels:

repos:
  - repo: https://github.com/vauxoo/ruff-pre-commit
    # Use the latest release tag; see the version scheme below.
    rev: 0.16.3.20
    hooks:
      - id: ruff-check
      - id: ruff-format

The hook ids match astral-sh/ruff-pre-commit, so switching between upstream and this fork means changing only repo and rev.

This repository also defines the hooks directly (see .pre-commit-hooks.yaml), but pointing repo at it builds Ruff from source with maturin on every environment creation, which is slow and requires a Rust toolchain. Prefer the mirror.

Version scheme

Fork releases use four components, x.y.z.w:

x.y.z is the upstream Ruff release this fork is based on (for example 0.16.2).
w counts the fork's own releases, independently of that upstream base.

So 0.16.2.4 is the fourth Vauxoo release, built on upstream Ruff 0.16.2. When the fork is synced onto a newer upstream, x.y.z follows it and w carries over untouched: syncing 0.16.2.4 onto upstream 0.16.3 gives 0.16.3.4, and the next release is 0.16.3.5. The counter never restarts, so a fork version is never reused and never goes backwards.

The version lives in [project] version of the root pyproject.toml and is bumped by bump2version (see .bumpversion.cfg), which also creates the release tag. Tags are the bare version with no prefix (0.16.2.4, not v0.16.2.4); pushing one triggers the PyPI release workflow. Because every fork tag has four components, it can never be confused with one of upstream's three-component tags.

Cargo cannot express a four-component version, so crates/ruff_odoo/Cargo.toml keeps the three-component x.y.z and crates/ruff/build.rs reads the real version out of pyproject.toml at build time, exposing it as RUFF_ODOO_VERSION. A build made outside a checkout of this repository falls back to the Cargo version.

Reporting the version

--version prints the bare version and nothing else:

$ ruff-odoo --version
ruff-odoo 0.16.3.20

It stays bare on purpose: tools that shell out to the binary (ruff-lsp, for one) parse that output as a PEP 440 version and fail on anything appended to it.

The version subcommand is the verbose one. It adds the number of commits since the release tag and the commit the binary was built from:

$ ruff-odoo version
ruff-odoo 0.16.3.20+3 (b45cfcb38 2026-08-15)

The leading name is the binary that was actually invoked, so a locally built ruff dev binary introduces itself as ruff. A release build sitting exactly on its tag has no +N suffix.

For machine-readable output, ask for JSON:

$ ruff-odoo version --output-format json
{
  "version": "0.16.3.20",
  "commit_info": {
    "short_commit_hash": "b45cfcb38",
    "commit_hash": "b45cfcb38d111d9f446b195125290a19e4cf8a4e",
    "commit_date": "2026-08-15",
    "last_tag": "0.16.3.20",
    "commits_since_last_tag": 3
  }
}

Building from source

The ruff-odoo binary is a thin wrapper crate (crates/ruff_odoo) around the untouched upstream ruff crate; the only differences are the displayed command name and the error prefix. Keeping the ruff crate and its binary unmodified is what keeps rebases onto upstream cheap.

Both binaries build from this checkout, and either one is fine for development:

cargo run --bin ruff-odoo -- check path/to/file.py
cargo run --bin ruff -- check path/to/file.py

See AGENTS.md for the full development workflow, and CONTRIBUTING.md for upstream's.

Download files

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

Source Distribution

ruff_odoo-0.16.3.20.tar.gz (5.0 MB view details)

Uploaded Aug 16, 2026 Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ruff_odoo-0.16.3.20-py3-none-win_arm64.whl (11.6 MB view details)

Uploaded Aug 16, 2026 Python 3Windows ARM64

ruff_odoo-0.16.3.20-py3-none-win_amd64.whl (11.5 MB view details)

Uploaded Aug 16, 2026 Python 3Windows x86-64

ruff_odoo-0.16.3.20-py3-none-win32.whl (11.2 MB view details)

Uploaded Aug 16, 2026 Python 3Windows x86

ruff_odoo-0.16.3.20-py3-none-musllinux_1_2_x86_64.whl (11.9 MB view details)

Uploaded Aug 16, 2026 Python 3musllinux: musl 1.2+ x86-64

ruff_odoo-0.16.3.20-py3-none-musllinux_1_2_i686.whl (11.4 MB view details)

Uploaded Aug 16, 2026 Python 3musllinux: musl 1.2+ i686

ruff_odoo-0.16.3.20-py3-none-musllinux_1_2_armv7l.whl (10.9 MB view details)

Uploaded Aug 16, 2026 Python 3musllinux: musl 1.2+ ARMv7l

ruff_odoo-0.16.3.20-py3-none-musllinux_1_2_aarch64.whl (11.2 MB view details)

Uploaded Aug 16, 2026 Python 3musllinux: musl 1.2+ ARM64

ruff_odoo-0.16.3.20-py3-none-manylinux_2_31_riscv64.whl (11.7 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.31+ riscv64

ruff_odoo-0.16.3.20-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.3 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.17+ x86-64

ruff_odoo-0.16.3.20-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl (12.0 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.17+ s390x

ruff_odoo-0.16.3.20-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (12.5 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.17+ ppc64le

ruff_odoo-0.16.3.20-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl (11.7 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.17+ i686

ruff_odoo-0.16.3.20-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (10.9 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.17+ ARMv7l

ruff_odoo-0.16.3.20-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (10.8 MB view details)

Uploaded Aug 16, 2026 Python 3manylinux: glibc 2.17+ ARM64

ruff_odoo-0.16.3.20-py3-none-macosx_11_0_arm64.whl (10.6 MB view details)

Uploaded Aug 16, 2026 Python 3macOS 11.0+ ARM64

ruff_odoo-0.16.3.20-py3-none-macosx_10_12_x86_64.whl (11.4 MB view details)

Uploaded Aug 16, 2026 Python 3macOS 10.12+ x86-64

ruff_odoo-0.16.3.20-py3-none-linux_armv6l.whl (11.0 MB view details)

Uploaded Aug 16, 2026 Python 3

File details

Details for the file ruff_odoo-0.16.3.20.tar.gz.

File metadata

Download URL: ruff_odoo-0.16.3.20.tar.gz
Upload date: Aug 16, 2026
Size: 5.0 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for ruff_odoo-0.16.3.20.tar.gz
Algorithm	Hash digest
SHA256	`4ebe60febef8299df3d005242371683d234a4232886b740394a2245529a1e69f`
MD5	`f124ecb73f7f23c158460d34ab99361f`
BLAKE2b-256	`933acc6985c4b7ceca4b3243efa36ac3a60b1a50299bcde04985bd67649db270`

Algorithm	Hash digest
SHA256	`436ff147cb751b623111d1e0f4d1c151a20790cb15949485a6c5dd6325ffe673`
MD5	`51c1c155720c3ff8af1de123a724d56d`
BLAKE2b-256	`e52ee37e944ae1f2daac970f2168c41b93aa14bd017d8778085006ebdb67a27d`

Algorithm	Hash digest
SHA256	`f14a4b5409e65527056d8e250af45042ec22c9bebd43329777b604af4ec19ad8`
MD5	`4a43e9ed19f4439ef141061933e72df4`
BLAKE2b-256	`9ad7422250b9b0f9f8edca9c594af63fbd845a4bc7caab1f120935f2c71846de`

Algorithm	Hash digest
SHA256	`1abe44e5a720aed4a1e22281755d0ce606cf161e9bb8cb00009c8abccb642f72`
MD5	`d286714744ae805d236c99bb6ee173d4`
BLAKE2b-256	`5c1cdb9653fade61fabaf933fd831922289f54fa2d6d15c796fe1eafd8430f55`

Algorithm	Hash digest
SHA256	`375b0a92e03ac9a15e827d915c221e4c1f5a3dc52a7f183236c65f8c9c69dad5`
MD5	`e71bf9f73c53b007d3b4e3be4fc1fbcd`
BLAKE2b-256	`38810ec7fb9275dd5a9c5b963a23c9dfa1146ca83c4402736a253fbc7554ac7d`

Algorithm	Hash digest
SHA256	`98201814014b43a0db5769a6d703eb1b513052c90b88e9663e59cae290948d45`
MD5	`3a3d3511556a39f1780d119dd15b6103`
BLAKE2b-256	`cda5bdbcc2f93369a68c25f62e7487f30d11e27dc27625a871e9d4393d3264f5`

Algorithm	Hash digest
SHA256	`83b46b544e1c90836208bd613a731640a59972bdee2bc8e208ed06e825fc9e8f`
MD5	`26e8811ba6e2f9a8021fd3227fff6d1b`
BLAKE2b-256	`856b27a1555f03cbf28307315fa1bdbbc23e9ecb5d61ee42cf4fc37ec8204ea5`

Algorithm	Hash digest
SHA256	`7be7a74f62832a53e085f38bac39f7c6d8fde0524f103d9e80398396702192b4`
MD5	`685ef51257839236093fdf6e76f2e968`
BLAKE2b-256	`e4e47f124ef7000c5e0cebaeb5bf93ea8500806c05cd36c6466585422bfa5e05`

Algorithm	Hash digest
SHA256	`2f1a20774ea5225960f34594b45389f6033d42c4fc4b2c70a22ec81837502d45`
MD5	`59ea3ec1bf6ac2c393f03a50a24669bf`
BLAKE2b-256	`8681b00da3d968d2352c6dbd7a582284a048c4dd5042d4f08eec0bf6ebaefc5d`

Algorithm	Hash digest
SHA256	`e07305bb125b72ff46d447a2aa7b251a4e1e647cbd6b4b5ca8263cd750151460`
MD5	`133feefca8d41dd6108cef3209a73d16`
BLAKE2b-256	`5d7e1b8e030d9a7a96006caf0554f69d2de741cc98bd3c9e880a57f7e1839bdf`

Algorithm	Hash digest
SHA256	`adf01265ae432037d282825dceb34f207eb262eaf766ec16723b1807f2bd702e`
MD5	`36f83e34b893b367bf8d81c94cb72c0f`
BLAKE2b-256	`43dfb9922912e0fabb98be6b9a28c51b88d8db2bef09f57a2b72a55b6bce9e43`

Algorithm	Hash digest
SHA256	`4c26b1ebb9ce163d1bdf6904ec006b86288d7ba84e1c9f20aa57bd99faf028ed`
MD5	`d56d7e9821bc445fa2810d85db023e9a`
BLAKE2b-256	`2fa340c4420544a8f789c791551518741bd8c26a89a499e160beb3875fd03b58`

Algorithm	Hash digest
SHA256	`63e0c6dccc538b93768f050377d08799913bc9a9339ee25cb0c61cfef8636281`
MD5	`c136dcd94ec18f81fae6baa370864276`
BLAKE2b-256	`6a23429a76d3f23c4568f39865b177d6adabffbf6c02f14c2aabeb2ab800f739`

Algorithm	Hash digest
SHA256	`44f042638b8e6c11cb62cc8004168b70380b7f36971b1e44d32ca0e4d091079a`
MD5	`ba36ae814bac87feb3eb6974a8c6b1f0`
BLAKE2b-256	`8df3758afb5ccb7172a2be298925f8c4852d68604a49cac5b8dfbd8d54794ff9`

Algorithm	Hash digest
SHA256	`3ade96e00c7ee29b19f090f5795565c5d61f15df360d2a4a9323888acd6fedb6`
MD5	`8ffda9cf1574c580635bbf14267b8c91`
BLAKE2b-256	`bfae04f42b54681ab976dce5fc9596cf6092407d84818d18ec51b19025f86890`

Algorithm	Hash digest
SHA256	`fc6d28d97b3d2b736bd3befc4e85e03ef4536eced10b81a651aa67ae437d65d7`
MD5	`0661edfb0402ced692ec6f896ebb1e88`
BLAKE2b-256	`62c68c1765eb02a296c2176813d4c19347b82c889c25c7c4600bb8acdde8dc60`

Algorithm	Hash digest
SHA256	`79ab1568dc091a0a99dd2aa2d87a2550060e1689795c9533343cb2b648365c12`
MD5	`e51cac186bf33811e378d70f18b3ea58`
BLAKE2b-256	`87469f95a191aca1a44a6e6dffb8d6900f521e7d533842de8c63c21d65a6f5b9`

Algorithm	Hash digest
SHA256	`3478d9f9af11b17b8bf49a2403ea5b91db9e90c227c6c6eab184a3dbc0a0a2c6`
MD5	`e459850729d8d882efecfbbdc74c8d2b`
BLAKE2b-256	`653899b45b9f72cec783762e5e92c6d2c49004f37505361d8314144136b06afc`

ruff-odoo 0.16.3.20

ruff-odoo

The ruff-odoo command

Installation

pre-commit

Version scheme

Reporting the version

Building from source

Project links

Key dates

2 maintainers

Credits

GitHub Statistics

License expression

Requires

Tags

Classifiers

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

Release history Release notifications | RSS feed

The `ruff-odoo` command