Repolode
nbQA-dev

nbQA-dev/nbQA

Una herramienta CLI para ejecutar linters y formateadores de Python, como ruff, isort, black, mypy y flake8, directamente en Jupyter Notebooks.

Estrellas
1,208
Forks
52
Issues abiertos
24
Último commit
hace 5 horas

¿Qué es?

nbQA permite ejecutar herramientas estándar de calidad de código de Python en Jupyter Notebooks sin tener que convertirlos antes en scripts. Las celdas de código de los notebooks se analizan como Python, y las celdas Markdown se pueden procesar con herramientas como blacken-docs. Es compatible con una amplia variedad de herramientas, entre ellas black, isort, pyupgrade, ruff, flake8, mypy, pylint, yapf, autopep8, pydocstyle y doctest.

La herramienta gestiona las magics de IPython, respeta los archivos de configuración existentes y conserva los puntos y comas finales que se usan para suprimir la salida de los notebooks. También admite notebooks .md vinculados con Jupytext. Se puede ejecutar desde la línea de comandos o integrar mediante hooks de pre-commit, para que los notebooks reciban las mismas comprobaciones que el resto del código.

Funciones clave

  • 01Ejecuta black, isort, ruff, flake8, mypy, pylint y otras herramientas en las celdas de código de los notebooks
  • 02Procesa celdas Markdown con herramientas como blacken-docs
  • 03Gestiona las magics de IPython sin alterar el código de los notebooks
  • 04Respeta los archivos de configuración existentes de las herramientas
  • 05Es compatible con notebooks .md con formato de Jupytext
  • 06Ofrece integración mediante hooks de pre-commit

Casos de uso

  • Aplicar estándares de linting y formato a los notebooks de ciencia de datos de un repositorio
  • Ejecutar comprobaciones de tipos con mypy en notebooks dentro de pipelines de CI
  • Aplicar formato automáticamente al código de los notebooks y a la documentación Markdown antes de hacer un commit
  • Actualizar la sintaxis de Python en una colección de notebooks antiguos

Inicio rápido

  1. 1

    Instala nbQA con pip en tu entorno virtual

    python -m pip install -U nbqa
  2. 2

    Opcionalmente, instala todos los linters y formateadores compatibles

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

    Ejecuta un formateador en un notebook, por ejemplo, black

    nbqa black my_notebook.ipynb

Antes de usarlo

  • Debes instalar cada linter o formateador por separado, a menos que uses el extra toolchain.

Temas

Preguntas frecuentes

¿Qué es nbQA?
Una herramienta CLI para ejecutar linters y formateadores de Python, como ruff, isort, black, mypy y flake8, directamente en Jupyter Notebooks. nbQA permite ejecutar herramientas estándar de calidad de código de Python en Jupyter Notebooks sin tener que convertirlos antes en scripts. Las celdas de código de los notebooks se analizan como Python, y las celdas Markdown se pueden procesar con herramientas como blacken-docs. Es compatible con una amplia variedad de herramientas, entre ellas black, isort, pyupgrade, ruff, flake8, mypy, pylint, yapf, autopep8, pydocstyle y doctest.
¿nbQA es gratuito? ¿Qué licencia tiene?
nbQA es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿nbQA sigue mantenido?
Mantenimiento activo. El último commit de nbQA fue el 6 nov 2026.
¿Para qué puedo usar nbQA?
Aplicar estándares de linting y formato a los notebooks de ciencia de datos de un repositorio Ejecutar comprobaciones de tipos con mypy en notebooks dentro de pipelines de CI Aplicar formato automáticamente al código de los notebooks y a la documentación Markdown antes de hacer un commit Actualizar la sintaxis de Python en una colección de notebooks antiguos
¿Cómo se instala nbQA?
Instala nbQA con pip en tu entorno virtual: python -m pip install -U nbqa Opcionalmente, instala todos los linters y formateadores compatibles: python -m pip install -U "nbqa[toolchain]" Ejecuta un formateador en un notebook, por ejemplo, black: nbqa black my_notebook.ipynb
¿Dónde consigo nbQA?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/nbQA-dev/nbQA

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados