Run any Python code quality tool on a Jupyter Notebook!
Project description
nbQA
Adapter to run any standard code-quality tool on a Jupyter notebook. Documentation is hosted here.
Installation
Install nbqa with pip:
pip install -U nbqa
Examples
Reformat your notebook with black:
$ nbqa black my_notebook.ipynb --line-length=96 --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
Check your type annotations with mypy:
$ nbqa mypy my_notebook.ipynb --ignore-missing-imports
my_notebook.ipynb:cell_10:5: error: Argument "num1" to "add" has incompatible type "str"; expected "int"
Run your docstring tests with doctest:
$ nbqa doctest my_notebook.ipynb
**********************************************************************
File "my_notebook.ipynb", cell_2:11, in my_notebook.add
Failed example:
add(2, 2)
Expected:
4
Got:
5
**********************************************************************
1 items had failures:
1 of 2 in my_notebook.hello
***Test Failed*** 1 failures.
Configuration
Here's an example .nbqa.ini file - see
configuration
for more on configuration:
[isort]
config = setup.cfg
mutate = 1
addopts = --treat-comment-as-code '# %%%%'
[flake8]
config = setup.cfg
Usage as pre-commit hook
If you want to use nbqa with pre-commit,
here's an example of what you could add to your
.pre-commit-config.yaml file:
- repo: https://github.com/nbQA-dev/nbQA
rev: 0.1.31
hooks:
- id: nbqa
args: ["flake8"]
name: nbqa-flake8
alias: nbqa-flake8
additional_dependencies: ["flake8"]
- id: nbqa
args: ["isort", "--nbqa-mutate"]
name: nbqa-isort
alias: nbqa-isort
additional_dependencies: ["isort"]
Supported third party packages
In theory, nbqa can adapt any Python code-quality tool to a Jupyter Notebook.
In practice, here are the tools it's been tested with:
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.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
 Marco Gorelli 💻 🚧 👀 ⚠️ 🤔 |
 Sebastian Weigand 🔧 👀 📖 🤔 |
 Girish Pasupathy 💻 🚇 🐛 👀 🤔 |
 fcatus 🚇 |
 HD23me 🐛 |
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.
Source Distribution
Built Distribution
File details
Details for the file nbqa-0.1.31.tar.gz.
File metadata
- Download URL: nbqa-0.1.31.tar.gz
- Upload date:
- Size: 21.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c1b4164164b2733ed75925bf4ad5d4460f22cfdd5baac9eebed0a3ec063adfc0 |
|
| MD5 | 88a4f69e511457c4ff1792b1ee262c74 |
|
| BLAKE2b-256 | 92988b2f0b1cb8316bd2d5b1c44d63bd66218c880121c674c00bb59e7cce08d2 |
Provenance
File details
Details for the file nbqa-0.1.31-py3-none-any.whl.
File metadata
- Download URL: nbqa-0.1.31-py3-none-any.whl
- Upload date:
- Size: 20.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 06cf187e8b03e26224fbfc611f049961ecde80f2022e3d62a11922224d945421 |
|
| MD5 | dd39a699a14746b349572174349a8dd9 |
|
| BLAKE2b-256 | 1023c841eee76af43fcdfff694ba83104c04ca2dc911a42d833269b5b293d886 |
