nbQA: A Python repository from caioariede

Run any standard Python code quality tool on a Jupyter Notebook

Table of contents

🎉 Installation

In your virtual environment, run one of the following:

python -m pip install -U nbqa (minimal installation)
python -m pip install -U nbqa[toolchain] (install supported code quality tools as well)
conda install -c conda-forge nbqa (if you use conda)

🚀 Examples

Command-line

Reformat your notebooks with black:

$ nbqa black my_notebook.ipynb --nbqa-mutate
reformatted my_notebook.ipynb
All done! ✨ 🍰 ✨
1 files reformatted.

Sort your imports with isort:

$ nbqa isort my_notebook.ipynb --treat-comment-as-code '# %%' --nbqa-mutate
Fixing my_notebook.ipynb

Upgrade your syntax with pyupgrade:

$ nbqa pyupgrade my_notebook.ipynb --py36-plus --nbqa-mutate
Rewriting my_notebook.ipynb

See command-line examples for examples involving pylint, flake8, doctest, and mypy.

Pre-commit

Here's an example of how to set up some pre-commit hooks:

Put this in your pyproject.toml file (see configuration for details)

[tool.nbqa.config]
isort = "setup.cfg"
black = "pyproject.toml"

[tool.nbqa.mutate]
isort = 1
black = 1
pyupgrade = 1

[tool.nbqa.addopts]
isort = ["--treat-comment-as-code", "# %%"]
pyupgrade = ["--py36-plus"]

Put this in your .pre-commit-config.yaml file (see usage as pre-commit hook)

- repo: https://github.com/nbQA-dev/nbQA
  rev: 0.3.5
  hooks:
    - id: nbqa-black
    - id: nbqa-pyupgrade
    - id: nbqa-isort

🥳 Used by

Take some inspiration from their config files 😉

PyMC3: pyproject.toml .pre-commit-config.yaml
pandas-profiling .pre-commit-config.yaml
alibi .pre-commit-config.yaml
NLP Profiler: pyproject.toml .pre-commit-config.yaml

💬 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

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

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

Girish Pasupathy, Software engineer and now core-contributor:

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

👥 Contributing

I will give write-access to anyone who contributes anything useful (e.g. pull request / bug report) - see the contributing guide for details on how to do so.

Thanks goes to these wonderful people (emoji key):

_{Marco Gorelli} 💻 🚧 👀 ⚠️ 🤔	_{Sebastian Weigand} 🔧 👀 📖 🤔	_{Girish Pasupathy} 💻 🚇 🐛 👀 🤔	_fcatus 🚇	_HD23me 🐛	_mani 🤔 🚇	_{Daniel Mietchen} 🤔
_{Michał Gacka} 🐛	_Happy 📖	_{Nat Taylor} 🐛