Skip to main content

Run any standard Python code quality tool on a Jupyter Notebook

Project description

nbQA

Run any standard Python code quality tool on a Jupyter Notebook

tox codecov pre-commit

versions chat docs

demo

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 pylint, flake8, doctest, and mypy.

Pre-commit

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

  1. 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]
    pyupgrade = ["--py36-plus"]
    
  2. Put this in your .pre-commit-config.yaml file (see usage as pre-commit hook)

    - repo: https://github.com/nbQA-dev/nbQA
      rev: 0.4.1
      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 ๐Ÿ˜‰

๐Ÿ’ฌ 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

๐Ÿ‘ฅ 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

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

Sebastian Weigand

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

Girish Pasupathy

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

fcatus

๐Ÿš‡

HD23me

๐Ÿ›

mani

๐Ÿค” ๐Ÿš‡

Daniel Mietchen

๐Ÿค”

Michaล‚ Gacka

๐Ÿ›

Happy

๐Ÿ“–

Nat Taylor

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

Caio Ariede

๐Ÿ“–

Nikita Sobolev

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

Amichay Oren

๐Ÿค”

pylang

๐Ÿค”

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.4.1.tar.gz (30.4 kB view hashes)

Uploaded Source

Built Distribution

nbqa-0.4.1-py2.py3-none-any.whl (58.6 kB view hashes)

Uploaded Python 2 Python 3

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