• Stars
    star
    1,026
  • Rank 44,887 (Top 0.9 %)
  • Language
    Python
  • License
    MIT License
  • Created over 4 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Run ruff, isort, pyupgrade, mypy, pylint, flake8, and more on Jupyter Notebooks

nbQA

Run ruff, isort, pyupgrade, mypy, pylint, flake8, black, blacken-docs, and more on Jupyter Notebooks

tox codecov pre-commit

versions chat docs

downloads

demo

  • โœ… handles IPython magics robustly
  • โœ… respects your config files
  • โœ… preserves "quiet mode" trailing semicolons
  • โœ… lints both code and markdown cells

Table of contents

๐ŸŽ‰ Installation

In your virtual environment, run (note: the $ is not part of the command):

$ python -m pip install -U nbqa

To also install all supported linters/formatters:

$ python -m pip install -U "nbqa[toolchain]"

๐Ÿš€ Examples

Command-line

Reformat your notebooks with black:

$ nbqa black my_notebook.ipynb
reformatted my_notebook.ipynb
All done! โœจ ๐Ÿฐ โœจ
1 files reformatted.

Sort your imports with isort:

$ nbqa isort my_notebook.ipynb --float-to-top
Fixing my_notebook.ipynb

Upgrade your syntax with pyupgrade:

$ nbqa pyupgrade my_notebook.ipynb --py37-plus
Rewriting my_notebook.ipynb

Format your markdown cells with blacken-docs:

$ nbqa blacken-docs my_notebook.ipynb --nbqa-md --nbqa-diff
Cell 2
------
--- my_notebook.ipynb
+++ my_notebook.ipynb
@@ -1,2 +1 @@
-First level heading
-===
+# First level heading

To apply these changes, remove the `--nbqa-diff` flag

Format .md files saved via Jupytext (requires jupytext to be installed):

$ nbqa black my_notebook.md
reformatted my_notebook.md
All done! โœจ ๐Ÿฐ โœจ
1 files reformatted.

See command-line examples for examples involving doctest, flake8, mypy, pylint, autopep8, pydocstyle, yapf, and ruff.

Pre-commit

Here's an example of how to set up some pre-commit hooks: put this in your .pre-commit-config.yaml file (see usage as pre-commit hook)

- repo: https://github.com/nbQA-dev/nbQA
  rev: 1.8.5
  hooks:
    - id: nbqa-black
      additional_dependencies: [jupytext]  # optional, only if you're using Jupytext
    - id: nbqa-pyupgrade
      args: ["--py37-plus"]
    - id: nbqa-isort
      args: ["--float-to-top"]

If you need to select specific versions of these linters/formatters, add them to additional_dependencies.

๐Ÿฅณ Used by

Click here for (non-exhaustive) list of repos

Is your project missing? Let us know, or open a pull request!

๐Ÿ’ฌ Testimonials

Michael Kennedy & Brian Okken, hosts of the Python Bytes podcast:

This is really cool. I think it brings so much of the code formatting and code analysis, clean up to notebooks, which I think had been really lacking

Nikita Sobolev, CTO at wemake.services:

It is amazing!

Alex Andorra, Data Scientist, ArviZ & PyMC Dev, Host of 'Learning Bayesian Statistics' Podcast:

well done on nbqa @MarcoGorelli ! Will be super useful in CI

Matthew Feickert, Postdoc at University of Illinois working on LHC physics:

nbqa in your pre-commit hooks along with @codewithanthony 's pre-commit CI service is amazing! Everyone using Jupyter notebooks should be doing this.

Girish Pasupathy, Software engineer and now core-contributor:

thanks a lot for your effort to create such a useful tool

Simon Brugman, Data scientist & pandas-profiling dev:

nbQA helps us to keep notebooks to the same standards as the rest of the code. If you're serious about your code standards, you should keep them consistent across both notebooks and python scripts. Great addition to the ecosystem, thanks!

Bradley Dice, PhD Candidate in Physics & Scientific Computing:

nbqa is a clean, easy to use, and effective tool for notebook code style. Formatting and readability makes a huge difference when rendering notebooks in a project's documentation!

James Lamb, engineer @saturn_cloud, LightGBM maintainer

today I learned about nbqa, a command-line tool to run linters like flake8 over #Python code in @ProjectJupyter notebooks. Thanks to @jayyqi for pointing me to it. So far, I really really like it.

Lars Yencken, Tech Lead @ Our World In Data

Super useful! I only wish it was built-in to Jupyterlab.

Vincent D. Warmerdam, maintainer @ calmcode.io

Nice. nbQA looks like a great way to prevent the Untitled12.ipynb-phenomenon. I like!

Mani Sarkar, Kaggle 3x expert, contributor

nbQA is an inspiring project, and the team behind it are very knowledgeable and think of things outside the box with ideas and solutions

๐Ÿ‘ฅ Contributing

I will give write-access to anyone who makes a useful pull request - see the contributing guide for details on how to do so.

Thanks goes to these wonderful people (emoji key):

Marco Gorelli
Marco Gorelli

๐Ÿ’ป ๐Ÿšง ๐Ÿ‘€ โš ๏ธ ๐Ÿค”
Sebastian Weigand
Sebastian Weigand

๐Ÿ”ง ๐Ÿ‘€ ๐Ÿ“– ๐Ÿค”
Girish Pasupathy
Girish Pasupathy

๐Ÿ’ป ๐Ÿš‡ ๐Ÿ› ๐Ÿ‘€ ๐Ÿค”
fcatus
fcatus

๐Ÿš‡
HD23me
HD23me

๐Ÿ›
mani
mani

๐Ÿค” ๐Ÿš‡
Daniel Mietchen
Daniel Mietchen

๐Ÿค”
Michaล‚ Gacka
Michaล‚ Gacka

๐Ÿ›
Happy
Happy

๐Ÿ“–
Nat Taylor
Nat Taylor

๐Ÿค” ๐Ÿ’ป ๐Ÿ”ง ๐Ÿ›
Caio Ariede
Caio Ariede

๐Ÿ“–
Nikita Sobolev
Nikita Sobolev

๐Ÿค” ๐Ÿ› ๐Ÿ“–
Amichay Oren
Amichay Oren

๐Ÿค”
pylang
pylang

๐Ÿค”
Henry Schreiner
Henry Schreiner

๐Ÿ›
Kaiqi Dong
Kaiqi Dong

๐Ÿ“–
Simon Brugman
Simon Brugman

๐Ÿ›
John Sandall
John Sandall

๐Ÿ›
Nathan Cooper
Nathan Cooper

๐Ÿ›
agruenberger
agruenberger

๐Ÿ›
Rafal Wojdyla
Rafal Wojdyla

๐Ÿ›
Bradley Dice
Bradley Dice

๐Ÿค” ๐Ÿ’ป
Ivan Cheung
Ivan Cheung

๐Ÿ›
Tony Hirst
Tony Hirst

๐Ÿ›
Taneli Hukkinen
Taneli Hukkinen

๐Ÿšง
Tom Begley
Tom Begley

๐Ÿค” ๐Ÿ’ป ๐Ÿ“–
Steven DeMartini
Steven DeMartini

๐Ÿ“–
vincent d warmerdam
vincent d warmerdam

โœ…
Daniel Sparing
Daniel Sparing

๐Ÿ›
asdfCYBER
asdfCYBER

๐Ÿ“–
Chris Knight
Chris Knight

๐Ÿ›
Laura Richter
Laura Richter

๐Ÿค”
Francesco Ballarin
Francesco Ballarin

๐Ÿ›
Janosh Riebesell
Janosh Riebesell

๐Ÿ› ๐Ÿ“–
Nicolas Oliver
Nicolas Oliver

๐Ÿ›
Bas Nijholt
Bas Nijholt

๐Ÿค”
Ralf Gommers
Ralf Gommers

๐Ÿค”
Toon Verstraelen
Toon Verstraelen

๐Ÿ“–
Trinh Quoc Anh
Trinh Quoc Anh

๐Ÿ›
Martin K. Scherer
Martin K. Scherer

๐Ÿ’ป
Felix Williams
Felix Williams

๐Ÿ› ๐Ÿš‡ ๐Ÿ›
Florian Bรคr
Florian Bรคr

๐Ÿ“–
Michael Kennedy
Michael Kennedy

๐Ÿ”Š
Brian Okken
Brian Okken

๐Ÿ”Š
Sydney
Sydney

๐Ÿ›
fvonbergen
fvonbergen

๐Ÿ›
Gaรฉtan Lepage
Gaรฉtan Lepage

โš ๏ธ

This project follows the all-contributors specification. Contributions of any kind welcome!