nbQA-dev/nbQA

O que é?

Recursos principais

• 01Executa black, isort, ruff, flake8, mypy, pylint e outras ferramentas nas células de código dos notebooks
• 02Processa células Markdown com ferramentas como blacken-docs
• 03Lida com magics do IPython sem quebrar o código dos notebooks
• 04Respeita os arquivos de configuração existentes das ferramentas
• 05Funciona com notebooks .md formatados pelo Jupytext
• 06Oferece integração com hooks do pre-commit

Casos de uso

• Aplicar padrões de lint e formatação a notebooks de ciência de dados em um repositório
• Executar verificações de tipos com mypy em notebooks nos pipelines de CI
• Formatar automaticamente o código dos notebooks e a documentação em Markdown antes de fazer commit
• Atualizar a sintaxe Python em um conjunto de notebooks antigos

Início rápido

1. 1

   Instale o nbQA com pip no seu ambiente virtual

   python -m pip install -U nbqa
2. 2

   Opcionalmente, instale todos os linters e formatadores compatíveis

   python -m pip install -U "nbqa[toolchain]"
3. 3

   Execute um formatador em um notebook, por exemplo, o black

   nbqa black my_notebook.ipynb

Antes de usar

• !Cada linter ou formatador deve ser instalado separadamente, a menos que você use o extra toolchain.

Tópicos

Perguntas frequentes

O que é nbQA?

Ferramenta de CLI que executa linters e formatadores Python, como ruff, isort, black, mypy e flake8, diretamente em Jupyter Notebooks. O nbQA permite executar ferramentas padrão de qualidade de código Python em Jupyter Notebooks sem precisar convertê-los em scripts. As células de código dos notebooks são verificadas como Python, e as células Markdown podem ser processadas por ferramentas como blacken-docs. A ferramenta funciona com várias outras, incluindo black, isort, pyupgrade, ruff, flake8, mypy, pylint, yapf, autopep8, pydocstyle e doctest.

nbQA é gratuito? Qual é a licença?

nbQA é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.

nbQA ainda é mantido?

Manutenção ativa. O último commit de nbQA foi em 7 de nov. de 2026.

Para que posso usar nbQA?

Aplicar padrões de lint e formatação a notebooks de ciência de dados em um repositório Executar verificações de tipos com mypy em notebooks nos pipelines de CI Formatar automaticamente o código dos notebooks e a documentação em Markdown antes de fazer commit Atualizar a sintaxe Python em um conjunto de notebooks antigos

Como instalar nbQA?

Instale o nbQA com pip no seu ambiente virtual: python -m pip install -U nbqa Opcionalmente, instale todos os linters e formatadores compatíveis: python -m pip install -U "nbqa[toolchain]" Execute um formatador em um notebook, por exemplo, o black: nbqa black my_notebook.ipynb

Onde consigo nbQA?

O código-fonte e as instruções de instalação estão no GitHub: https://github.com/nbQA-dev/nbQA