Skip to main content

Run any Python code quality tool on a Jupyter Notebook!

Project description

logo

nbQA

image image image image image image

demo

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 --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.

Check for style guide enforcement with flake8:

$ nbqa flake8 my_notebook.ipynb --extend-ignore=E203,E302,E305,E703
my_notebook.ipynb:cell_3:1:1: F401 'import pandas as pd' imported but unused

Upgrade your syntax with pyupgrade:

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

Perform static code analysis with pylint:

$ nbqa pylint my_notebook.ipynb --disable=C0114
my_notebook.ipynb:cell_1:5:0: W0611: Unused import nbqa (unused-import)

🔧 Configuration

You can configure nbqa either at the command line, or by using a pyproject.toml file - see configuration for details and examples.

👷 Usage as pre-commit hook

You can easily use nbqa as a pre-commit hook by passing your desired code quality tool in the args and additional_dependencies sections - see usage as pre-commit hook for examples.

💬 Testimonials

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

🤔

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

Project details


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

nbqa-0.3.0.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

nbqa-0.3.0-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file nbqa-0.3.0.tar.gz.

File metadata

  • Download URL: nbqa-0.3.0.tar.gz
  • Upload date:
  • Size: 28.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.5

File hashes

Hashes for nbqa-0.3.0.tar.gz
Algorithm Hash digest
SHA256 9c4a3b6cceda83b78c8a890b6486abbc4fdaee66dad20a800b97919f3d506d39
MD5 d79beab2884a28aba1fdcacd545ec88d
BLAKE2b-256 a7a89f3acd15abf4a332341f9ea8d3194a68d2a796ee56362ed9cbc30e3d1a28

See more details on using hashes here.

Provenance

File details

Details for the file nbqa-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: nbqa-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 28.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.5

File hashes

Hashes for nbqa-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b1c162cb31383c89bdd607650095a2fadc449e801f94fc3e5fa8f69a2ae580c
MD5 fda1c572e3645298eb7581390db8de3a
BLAKE2b-256 3b121a04943f7973a4807094c3554e08e2a2ec64caeca03e3c833b6371a09fb0

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page