Run any standard Python code quality tool on a Jupyter Notebook
Project description
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 --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 autoflake, check-ast, doctest, flake8, mypy, and pylint.
Pre-commit
Here's an example of how to set up some pre-commit hooks:
-
Put this in your
pyproject.tomlfile (see configuration for details)[tool.nbqa.mutate] isort = 1 black = 1 pyupgrade = 1 [tool.nbqa.addopts] pyupgrade = ["--py36-plus"]
-
Put this in your
.pre-commit-config.yamlfile (see usage as pre-commit hook)- repo: https://github.com/nbQA-dev/nbQA rev: 0.5.3 hooks: - id: nbqa-black additional_dependencies: [black==20.8b1] - id: nbqa-pyupgrade additional_dependencies: [pyupgrade==2.7.3] - id: nbqa-isort additional_dependencies: [isort==5.6.4]
๐ฅณ Used by
Take some inspiration from their config files ๐
- alibi .pre-commit-config.yaml
- iminuit pyproject.toml .pre-commit-config.yaml
- intake-esm pyproject.toml .pre-commit-config.yaml
- LiuAlgoTrader: requirements/dev.txt
- mplhep: pyproject.toml .pre-commit-config.yaml
- NLP Profiler: pyproject.toml .pre-commit-config.yaml
- pandas-profiling .pre-commit-config.yaml
- pyhf pyproject.toml .pre-commit-config.yaml
- PyMC3: pyproject.toml .pre-commit-config.yaml
- PyMC Resources: pyproject.toml .pre-commit-config.yaml
- Python compiled microcourse: .pre-commit-config.yaml
- sktime: .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
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!
๐ฅ 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):
This project follows the all-contributors specification. Contributions of any kind welcome!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
