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: why it exists at all, the command name, the packaging, and the version scheme.

Why this exists

Vauxoo's Odoo checks used to live in pylint-odoo (a Pylint plugin) and odoo-pre-commit-hooks, running next to the autofixing tools already present in the pre-commit stack. Three problems pushed us to port those checks into Ruff instead, and none of them was something a patch to those projects could have fixed.

Autofixes corrupted each other. Every tool rewrote the file on its own, with no idea of what the others had done to it. A fix applied by one hook routinely invalidated a fix another hook had just applied, or uncovered a violation that only became reachable after the first rewrite. So the run ended dirty, the command had to be run a second time, and that run pulled in yet another fix. Getting a repository to a fixed point — a run that proposes no changes — commonly took three or four passes of the same command. That is confusing on a developer machine and simply broken in CI, where there is one run and a dirty tree is a failure.

Ruff does that iteration internally: it lints, applies every non-overlapping fix, re-parses the result, and repeats until the file stops changing, discarding any fix that would have introduced a syntax error. One invocation, one stable file.

Pylint has no autofixes. Pylint only reports. Any check we also wanted fixed automatically had to be written twice — once as a Pylint checker that reports it and once as a separate fixer that rewrites it — with two sets of tests, two notions of what the pattern is, and no guarantee the two stayed in agreement as they were maintained. In Ruff a fix is attached to the diagnostic that produced it, so the rule that finds a problem is the same code that repairs it, and its fixture covers both.

Speed, which mattered more than anything else. A linter is only run as often as it is cheap to run. Pylint infers types through astroid, and a stack of separate hooks pays for a process start and a fresh parse of every file per tool. Ruff parses each file once, in Rust, in parallel across cores, and caches unchanged files between runs — fast enough to run on save and on every commit rather than only in CI, which is what makes the rules actually shape the code being written instead of being discovered at review time.

Why a fork, and not a separate repository

The obvious alternative was to keep the Odoo rules in their own project and just depend on Ruff. It does not work, for reasons that are structural rather than incidental:

Ruff has no plugin system. Rules are compiled into the binary; there is no dynamic loading, no stable ABI, and no "register a rule" entry point to call from the outside. That is a deliberate design choice upstream — it is part of why a single static binary can dispatch rules with no per-rule overhead — not a gap waiting to be filled.
A rule is not self-contained. Adding one touches files that upstream owns: the code-to-rule map in codes.rs, the linter enum in registry.rs, the dispatch inside the AST visitor in checkers/ast/analyze/, the settings struct behind lint.odoo, and the generated JSON schema and docs. There is no seam an external crate could attach to.
The internal crates are not a public API. ruff_linter describes itself as "an internal component crate of Ruff": it is versioned with the binary and refactored freely. A separate project built on it would break on close to every upstream release, which is a worse maintenance burden than a rebase.
A second tool would recreate the original problem. Even with all of the above solved, shipping the Odoo rules as a second binary means a second process, a second parse, a second fix pass over the same file, a second configuration file, and a second suppression syntax. The whole point is that the Odoo rules run in the same pass as everything else: one command, one AST, one --fix, one # noqa, one cache, one pyproject.toml.

The cost of this choice is having to rebase onto upstream Ruff, and that is accepted knowingly. The fork is arranged to keep that cost low: the Odoo rules live in their own directory, upstream files are touched as little as possible, and the ruff crate and its binary are left untouched behind a thin wrapper crate.

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.31
    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.31

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.31+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.31",
  "commit_info": {
    "short_commit_hash": "b45cfcb38",
    "commit_hash": "b45cfcb38d111d9f446b195125290a19e4cf8a4e",
    "commit_date": "2026-08-15",
    "last_tag": "0.16.3.31",
    "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.31.tar.gz (5.0 MB view details)

Uploaded Aug 23, 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.31-py3-none-win_arm64.whl (11.6 MB view details)

Uploaded Aug 23, 2026 Python 3Windows ARM64

ruff_odoo-0.16.3.31-py3-none-win_amd64.whl (11.6 MB view details)

Uploaded Aug 23, 2026 Python 3Windows x86-64

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

Uploaded Aug 23, 2026 Python 3Windows x86

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

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

ruff_odoo-0.16.3.31-py3-none-musllinux_1_2_i686.whl (11.5 MB view details)

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

ruff_odoo-0.16.3.31-py3-none-musllinux_1_2_armv7l.whl (11.0 MB view details)

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

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

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

ruff_odoo-0.16.3.31-py3-none-manylinux_2_31_riscv64.whl (11.9 MB view details)

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

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

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

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

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

ruff_odoo-0.16.3.31-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (12.6 MB view details)

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

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

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

ruff_odoo-0.16.3.31-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (11.0 MB view details)

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

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

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

ruff_odoo-0.16.3.31-py3-none-macosx_11_0_arm64.whl (10.7 MB view details)

Uploaded Aug 23, 2026 Python 3macOS 11.0+ ARM64

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

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

ruff_odoo-0.16.3.31-py3-none-linux_armv6l.whl (11.2 MB view details)

Uploaded Aug 23, 2026 Python 3

File details

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

File metadata

Download URL: ruff_odoo-0.16.3.31.tar.gz
Upload date: Aug 23, 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.31.tar.gz
Algorithm	Hash digest
SHA256	`b5817c22f3ea3acc60e9f2afb9ce913878b6d73194a6972fdf7e5effc355ce36`
MD5	`14c4d92bd7ca392e5fb2df3986b52198`
BLAKE2b-256	`e592b71d9c23aba9dfb5f3d75383b119dad8266dff538411b50f1c43fd104787`

Algorithm	Hash digest
SHA256	`d0395e0f7670c42dff9a5aeea335a6e4e727bbebc324d1f6361973d8abec792d`
MD5	`56a41e599fb8ec809d5d0c91640ab609`
BLAKE2b-256	`7e5771ee053ab192d3d877a984d94845d1f7ce8f05bcc52ab965f0ae253eaf5b`

Algorithm	Hash digest
SHA256	`ff74c2e477d4f7cf1e4fb9bceefd3b5120a49436b16319769d426c0fe7b39a59`
MD5	`c83aa522dcbc316f459bad59642b64de`
BLAKE2b-256	`071b8421ccbb58302696ad1b2aa19b6c0b8de8aef1928451466164116b75b791`

Algorithm	Hash digest
SHA256	`5a1b0b8a1a1b80095b17015cf054bf4e5bfdac1508fc2752e317449e68dea5c0`
MD5	`d1d9192c9cc28c401aa905181f69222b`
BLAKE2b-256	`4f63c8a8110e6769b082f9cad3d62c9863e1261fe806a9980fc4f355dcc91930`

Algorithm	Hash digest
SHA256	`aba4acb87b8c3a036bd2e791963b0e8a0e6b9869b4c1439d55cafeb64e802fe2`
MD5	`ce858e15816d1d189da829697f0a402b`
BLAKE2b-256	`ce4731c61e8743d7cbac768b1f973d020f82ac869463bbbfdf829b6f834fbc06`

Algorithm	Hash digest
SHA256	`833ae449b8cae477e8315f394375b2676328ed3b0a3a5cfd22df32af2b3dca75`
MD5	`00ba12cfbdcc4c7e8e1125047649e71d`
BLAKE2b-256	`fa385aa20890c6a8f18f6980ffda42e59280570aecc6e39f224347e168220aeb`

Algorithm	Hash digest
SHA256	`4afdca30107334372433b78256824b2cb48b99b34242f71d338a7524c797786f`
MD5	`0d886da630220c3b055ccc296ed25065`
BLAKE2b-256	`29a4d7f70a9b5a093d449f99ce7787f106857ba4033fba59c536ec2471c47646`

Algorithm	Hash digest
SHA256	`b7a80e205138c365fdcd6b1b79f1bdcdfd559250324d02b1c5ffdc63eefbaea1`
MD5	`821141e274d4a92494d206e1b2093251`
BLAKE2b-256	`43657879c59ebd55c9390f49369f9c51d40b48f79e73052daf90e677ce45e2c5`

Algorithm	Hash digest
SHA256	`8de9a6c13ff9e5e6b504accc47bcc9a15e0ee74b43309b5636c5355c7ac5dba2`
MD5	`abcbb4a04380842200bdf6df18d26938`
BLAKE2b-256	`291707706a1c44b2597302cf657b8134d6840c79ac7a16fbfe357f9b5acda129`

Algorithm	Hash digest
SHA256	`ccc3ba2d605d95e87514f45e7b6b93752f35875834bdb1cb06f7e941c91e2e9d`
MD5	`abdfa3d74762b081ccf237cba8ba7dd6`
BLAKE2b-256	`24aad61250ac691339254f87fdf71641cebd2892993fbe0ef258b88044ab1911`

Algorithm	Hash digest
SHA256	`7a3de90c4eda2298226a894a244970ea48f181f19a117c2b14dcc97ebf805c1b`
MD5	`d8e8217dc14cbaaaf7ca7d19f1d72ae6`
BLAKE2b-256	`fb271955cfe92ea253a393b3b1b9065400a9fc9a450fc9f69462a50ac3fda6c1`

Algorithm	Hash digest
SHA256	`b11e86221f0592877b8791f2343911d1bbb34420d0caad4dc76b20425a9096fb`
MD5	`ad35b1fc7fdb5ebe39edc19b19bcc860`
BLAKE2b-256	`7dc4de569028e16ae4e35fcffc6b0065f5c03bc34e858e2a0345febdc4a2d5fe`

Algorithm	Hash digest
SHA256	`0f2596d0ca291cbc473a24e8f18ec433cd51b0805f226d875e398b14e1b034bc`
MD5	`38e7537b8bc104bda04ccda6a189b2dd`
BLAKE2b-256	`69ff07ce1905ce4df1d3bad899b55fd357119bd15af51f83abb740a7bcb58e01`

Algorithm	Hash digest
SHA256	`2ed0126490c97fecd2bb4417b5ed05440d31ac1a486f360ea0d67eb2879ea8c7`
MD5	`151c407bc643b4b17b1b5c0a6ea84a89`
BLAKE2b-256	`abbba1fd6bc9229bd1618f0aa405cce24842ad18638475374ad2c6586416631a`

Algorithm	Hash digest
SHA256	`539fbb44271db9fa399c0bf77ea831e0805e5595ddb323f0cd6b80bb84d11fec`
MD5	`7ca18a7f02069203c80632b77399ad72`
BLAKE2b-256	`88359d94803151ffb3ae097f6a13cee36a31210966b56a654c9a0697ffaabbde`

Algorithm	Hash digest
SHA256	`bac5aa11b2e62b174bee01e08927937fa3bdc100e11c78b9ce300b052bf59926`
MD5	`2bbe3328fd44315d411d7c3bb9e99f4e`
BLAKE2b-256	`19a914eb423ba87059fa9cc35434756f79af1888a9ed767244cf2cf20036546c`

Algorithm	Hash digest
SHA256	`f5f4f659c864508937322ae2f22c0597acff66a89a7e883faeed99a505898045`
MD5	`15ab5faa569ac891c9f27262a0c2ef62`
BLAKE2b-256	`f4934158e4320126910560f81d2f544c11043c8009da87033cd801996f779e12`

Algorithm	Hash digest
SHA256	`6e741372b79afa93072fb1eb26cfe32756e8716608fdc8fccfda09899fbe54a0`
MD5	`80bf87d2eaa7427fe995a5bdd185659f`
BLAKE2b-256	`d58b375af0f92c3cbb5493a6a3440cebb4821d451c2dc2f172ed21f8d99bd5f4`

ruff-odoo 0.16.3.31

ruff-odoo

Why this exists

Why a fork, and not a separate repository

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