Question 1

How to install and set up bellybutton for a new Python project?

Accepted Answer

Install via pip with 'pip install bellybutton', then run 'bellybutton init' in your project root to generate a .bellybutton.yml configuration file with examples. You can then adapt the rules to match your project's needs.

Question 2

Bellybutton vs pylint: which is better for custom project rules?

Accepted Answer

Bellybutton excels at defining project-specific rules via YAML with astpath or regex, making it more accessible for custom needs. Pylint offers comprehensive out-of-the-box checks but is harder to extend for internal standards.

Question 3

How to create a custom linting rule in bellybutton?

Accepted Answer

Define rules in .bellybutton.yml using an 'expr' field with astpath expressions or regex, plus optional 'example' and 'instead' clauses for validation. Refer to the README for detailed syntax and examples.

Question 4

Can bellybutton be integrated into a CI/CD pipeline?

Accepted Answer

Yes, it's designed for CI/CD with commands like 'bellybutton lint' for all files or '--modified-only' for git changes. The repository provides examples in tox.ini and .travis.yml for guidance.

Question 5

What are the main limitations of bellybutton?

Accepted Answer

As an alpha tool, it has unstable releases, incomplete features like !chain nodes, and performance issues on large codebases. Documentation is also sparse, making troubleshooting difficult.

Question 6

How to ignore a bellybutton rule in my code?

Accepted Answer

Add a '# bb: ignore' comment on the line violating the rule, but only if the rule's settings have 'allow_ignore' set to yes in the configuration file.

bellybutton

What is bellybutton?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions