coala

0.11.0 verified Fri May 01 auth: no python maintenance

Coala is a modular linting and fixing tool for all languages. Version 0.11.0 is the latest release (2017-10-30). The project is in maintenance mode with no recent updates. It uses a bear-based plugin system for language-specific analysis.

pip install coala-bears

Common errors

error ImportError: No module named 'coalib' ↓

cause Coala not installed or installed only coala-bears without core.

fix

Install coala core: pip install coala

error coalib.meta.CoalaProblem: There are no bears to run. ↓

cause No bears configured in .coafile or none matched.

fix

Add a bears line in .coafile, e.g., 'bears = SpaceConsistencyBear'.

error coalib.output.ConsoleInteraction: No files to process. ↓

cause Files setting in .coafile is empty or no files match the pattern.

fix

Set 'files = **.py' or similar glob in .coafile.

Warnings

deprecated Coala is in maintenance mode. Development has stalled since 2017. For new projects, consider alternatives like pre-commit or Ruff. ↓

fix Evaluate other linting tools for active development.

breaking Coala dropped support for Python 2 in version 0.11.0. Python 3.4+ required. ↓

fix Upgrade Python environment to 3.4+.

gotcha Coala configuration is via .coafile in the project root. Without it, coala will exit with 'No files to process'. ↓

fix Create a .coafile with sections for bears and files.

gotcha Common mistake: running coala without specifying bears leads to no checks. Explicitly enable bears in .coafile or CLI. ↓

fix Add bears setting like 'bears = SpaceConsistencyBear' in .coafile.

Install

pip install coala

Imports

main
wrong
```
import coalib
```
correct
```
from coalib import main
```
Direct import of coalib does not expose the CLI entry point; use from coalib import main to run programmatically.
CoalaBear
wrong
```
from coala import CoalaBear
```
correct
```
from coalib.bears import Bear
```
The base class is Bear, not CoalaBear; custom bears inherit from Bear.

Quickstart

Basic programmatic usage of coala; typically invoked from command line.

import os
from coalib import main
# Run coala programmatically (example)
# This requires a .coafile configuration; if not present, it will exit with an error.
# Instead, you can use the CLI: coala --help
print("Coala version: 0.11.0")