Metadata-Version: 2.1
Name: nbqa
Version: 0.5.2
Summary: Run any standard Python code quality tool on a Jupyter Notebook
Home-page: https://github.com/nbQA-dev/nbQA
Author: Marco Gorelli, Girish Pasupathy, Sebastian Weigand
License: MIT
Project-URL: Documentation, https://nbQA.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/nbQA-dev/nbQA
Project-URL: Tracker, https://github.com/nbQA-dev/nbQA/issues
Description: <h1 align="center">
        	<img
        		width="400"
        		alt="nbQA"
        		src="https://github.com/nbQA-dev/nbQA-demo/raw/master/assets/logo.png">
        </h1>
        
        <h3 align="center">
        	Run any standard Python code quality tool on a Jupyter Notebook
        </h3>
        
        <p align="center">
        	<a href="https://github.com/nbQA-dev/nbQA/actions?workflow=tox"><img
        		alt="tox"
        		src="https://github.com/nbQA-dev/nbQA/workflows/tox/badge.svg"></a>
        	<a href="https://codecov.io/gh/nbQA-dev/nbQA"><img
        		alt="codecov"
        		src="https://codecov.io/gh/nbQA-dev/nbQA/branch/master/graph/badge.svg"></a>
        	<a href="https://results.pre-commit.ci/latest/github/nbQA-dev/nbQA/master"><img
        		alt="pre-commit"
        		src="https://results.pre-commit.ci/badge/github/nbQA-dev/nbQA/master.svg"></a>
        </p>
        
        <p align="center">
        	<a href="https://pypi.org/project/nbqa/"><img
        		alt="versions"
        		src="https://img.shields.io/pypi/pyversions/nbqa.svg"></a>
        	<a href="https://gitter.im/nbQA/nbQA"><img
        		alt="chat"
        		src="https://badges.gitter.im/Join%20Chat.svg"></a>
        	<a href="https://nbqa.readthedocs.io/en/latest/"><img
        		alt="docs"
        		src="https://readthedocs.org/projects/nbqa/badge/?version=latest"></a>
        </p>
        
        <p align="center">
            <a href="#readme">
                <img alt="demo" src="https://raw.githubusercontent.com/nbQA-dev/nbQA-demo/master/demo.gif">
            </a>
        </p>
        
        # Table of contents
        
        - [Table of contents](#table-of-contents)
          - [🎉 Installation](#-installation)
          - [🚀 Examples](#-examples)
            - [Command-line](#command-line)
            - [Pre-commit](#pre-commit)
          - [🥳 Used by](#-used-by)
          - [💬 Testimonials](#-testimonials)
          - [👥 Contributing](#-contributing)
        
        ## 🎉 Installation
        
        In your [virtual environment](https://realpython.com/python-virtual-environments-a-primer/), 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](https://black.readthedocs.io/en/stable/):
        
        ```console
        $ nbqa black my_notebook.ipynb --nbqa-mutate
        reformatted my_notebook.ipynb
        All done! ✨ 🍰 ✨
        1 files reformatted.
        ```
        
        Sort your imports with [isort](https://timothycrosley.github.io/isort/):
        
        ```console
        $ nbqa isort my_notebook.ipynb --nbqa-mutate
        Fixing my_notebook.ipynb
        ```
        
        Upgrade your syntax with [pyupgrade](https://github.com/asottile/pyupgrade):
        
        ```console
        $ nbqa pyupgrade my_notebook.ipynb --py36-plus --nbqa-mutate
        Rewriting my_notebook.ipynb
        ```
        
        See [command-line examples](https://nbqa.readthedocs.io/en/latest/examples.html) for examples involving [autoflake](https://github.com/myint/autoflake), [check-ast](https://github.com/pre-commit/pre-commit-hooks#check-ast), [doctest](https://docs.python.org/3/library/doctest.html), [flake8](https://flake8.pycqa.org/en/latest/), [mypy](http://mypy-lang.org/), and [pylint](https://www.pylint.org/).
        
        ### 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](https://nbqa.readthedocs.io/en/latest/configuration.html)
        for details)
        
           ```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](https://nbqa.readthedocs.io/en/latest/pre-commit.html))
        
           ```yaml
           - repo: https://github.com/nbQA-dev/nbQA
             rev: 0.5.2
             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](https://github.com/SeldonIO/alibi/blob/master/.pre-commit-config.yaml)
        - **iminuit** [pyproject.toml](https://github.com/scikit-hep/iminuit/blob/develop/pyproject.toml) [.pre-commit-config.yaml](https://github.com/scikit-hep/iminuit/blob/develop/.pre-commit-config.yaml)
        - **intake-esm** [pyproject.toml](https://github.com/intake/intake-esm/blob/master/pyproject.toml) [.pre-commit-config.yaml](https://github.com/intake/intake-esm/blob/master/.pre-commit-config.yaml)
        - **LiuAlgoTrader**: [requirements/dev.txt](https://github.com/amor71/LiuAlgoTrader/blob/master/liualgotrader/requirements/dev.txt)
        - **mplhep**: [pyproject.toml](https://github.com/scikit-hep/mplhep/blob/master/pyproject.toml) [.pre-commit-config.yaml](https://github.com/scikit-hep/mplhep/blob/master/.pre-commit-config.yaml)
        - **NLP Profiler**: [pyproject.toml](https://github.com/neomatrix369/nlp_profiler/blob/master/pyproject.toml) [.pre-commit-config.yaml](https://github.com/neomatrix369/nlp_profiler/blob/master/.pre-commit-config.yaml)
        - **pandas-profiling** [.pre-commit-config.yaml](https://github.com/pandas-profiling/pandas-profiling/blob/develop/.pre-commit-config.yaml)
        - **pyhf** [pyproject.toml](https://github.com/scikit-hep/pyhf/blob/master/pyproject.toml) [.pre-commit-config.yaml](https://github.com/scikit-hep/pyhf/blob/master/.pre-commit-config.yaml)
        - **PyMC3**: [pyproject.toml](https://github.com/pymc-devs/pymc3/blob/master/pyproject.toml) [.pre-commit-config.yaml](https://github.com/pymc-devs/pymc3/blob/master/.pre-commit-config.yaml)
        - **PyMC Resources**: [pyproject.toml](https://github.com/pymc-devs/resources/blob/master/pyproject.toml) [.pre-commit-config.yaml](https://github.com/pymc-devs/resources/blob/master/.pre-commit-config.yaml)
        - **Python compiled microcourse**: [.pre-commit-config.yaml](https://github.com/henryiii/python-compiled-minicourse/blob/master/.pre-commit-config.yaml)
        - **sktime**: [.pre-commit-config.yaml](https://github.com/alan-turing-institute/sktime/blob/master/.pre-commit-config.yaml)
        
        ## 💬 Testimonials
        
        **Michael Kennedy & Brian Okken**, [hosts of the Python Bytes podcast](https://pythonbytes.fm/episodes/show/204/take-the-psf-survey-and-will-carlton-drop-by):
        
        > 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](https://github.com/nbQA-dev/nbQA/issues/386#issuecomment-718046313):
        
        > It is amazing!
        
        **Alex Andorra**,
        [Data Scientist, ArviZ & PyMC Dev, Host of 'Learning Bayesian Statistics' Podcast](https://github.com/pymc-devs/pymc3/pull/4074#pullrequestreview-482589774):
        
        > well done on `nbqa` @MarcoGorelli ! Will be super useful in CI
        
        **Matthew Feickert**
        [Postdoc at University of Illinois working on LHC physics](https://twitter.com/HEPfeickert/status/1324823925898027008):
        
        > 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](https://github.com/nbQA-dev/nbQA/issues/164#issuecomment-674529528):
        
        > 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](https://nbqa.readthedocs.io/en/latest/contributing.html)
        for details on how to do so.
        
        Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
        
        <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
        <!-- prettier-ignore-start -->
        <!-- markdownlint-disable -->
        <table>
          <tr>
            <td align="center"><a href="https://github.com/MarcoGorelli"><img src="https://avatars2.githubusercontent.com/u/33491632?v=4" width="100px;" alt=""/><br /><sub><b>Marco Gorelli</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/commits?author=MarcoGorelli" title="Code">💻</a> <a href="#maintenance-MarcoGorelli" title="Maintenance">🚧</a> <a href="https://github.com/nbQA-dev/nbQA/pulls?q=is%3Apr+reviewed-by%3AMarcoGorelli" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/nbQA-dev/nbQA/commits?author=MarcoGorelli" title="Tests">⚠️</a> <a href="#ideas-MarcoGorelli" title="Ideas, Planning, & Feedback">🤔</a></td>
            <td align="center"><a href="https://github.com/s-weigand"><img src="https://avatars2.githubusercontent.com/u/9513634?v=4" width="100px;" alt=""/><br /><sub><b>Sebastian Weigand</b></sub></a><br /><a href="#tool-s-weigand" title="Tools">🔧</a> <a href="https://github.com/nbQA-dev/nbQA/pulls?q=is%3Apr+reviewed-by%3As-weigand" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/nbQA-dev/nbQA/commits?author=s-weigand" title="Documentation">📖</a> <a href="#ideas-s-weigand" title="Ideas, Planning, & Feedback">🤔</a></td>
            <td align="center"><a href="https://github.com/girip11"><img src="https://avatars1.githubusercontent.com/u/5471162?v=4" width="100px;" alt=""/><br /><sub><b>Girish Pasupathy</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/commits?author=girip11" title="Code">💻</a> <a href="#infra-girip11" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3Agirip11" title="Bug reports">🐛</a> <a href="https://github.com/nbQA-dev/nbQA/pulls?q=is%3Apr+reviewed-by%3Agirip11" title="Reviewed Pull Requests">👀</a> <a href="#ideas-girip11" title="Ideas, Planning, & Feedback">🤔</a></td>
            <td align="center"><a href="https://github.com/fcatus"><img src="https://avatars0.githubusercontent.com/u/56323389?v=4" width="100px;" alt=""/><br /><sub><b>fcatus</b></sub></a><br /><a href="#infra-fcatus" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
            <td align="center"><a href="https://github.com/HD23me"><img src="https://avatars3.githubusercontent.com/u/68745664?v=4" width="100px;" alt=""/><br /><sub><b>HD23me</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3AHD23me" title="Bug reports">🐛</a></td>
            <td align="center"><a href="https://neomatrix369.wordpress.com/about"><img src="https://avatars0.githubusercontent.com/u/1570917?v=4" width="100px;" alt=""/><br /><sub><b>mani</b></sub></a><br /><a href="#ideas-neomatrix369" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-neomatrix369" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
            <td align="center"><a href="https://orcid.org/0000-0001-9488-1870"><img src="https://avatars3.githubusercontent.com/u/465923?v=4" width="100px;" alt=""/><br /><sub><b>Daniel Mietchen</b></sub></a><br /><a href="#ideas-Daniel-Mietchen" title="Ideas, Planning, & Feedback">🤔</a></td>
          </tr>
          <tr>
            <td align="center"><a href="https://gacka.space/"><img src="https://avatars1.githubusercontent.com/u/25684390?v=4" width="100px;" alt=""/><br /><sub><b>Michał Gacka</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3Am3h0w" title="Bug reports">🐛</a></td>
            <td align="center"><a href="https://github.com/HappyFacade"><img src="https://avatars0.githubusercontent.com/u/54226355?v=4" width="100px;" alt=""/><br /><sub><b>Happy</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/commits?author=HappyFacade" title="Documentation">📖</a></td>
            <td align="center"><a href="https://github.com/ntaylor-nanigans"><img src="https://avatars0.githubusercontent.com/u/44039328?v=4" width="100px;" alt=""/><br /><sub><b>Nat Taylor</b></sub></a><br /><a href="#ideas-ntaylor-nanigans" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nbQA-dev/nbQA/commits?author=ntaylor-nanigans" title="Code">💻</a> <a href="#tool-ntaylor-nanigans" title="Tools">🔧</a> <a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3Antaylor-nanigans" title="Bug reports">🐛</a></td>
            <td align="center"><a href="http://caioariede.github.io/"><img src="https://avatars0.githubusercontent.com/u/55533?v=4" width="100px;" alt=""/><br /><sub><b>Caio Ariede</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/commits?author=caioariede" title="Documentation">📖</a></td>
            <td align="center"><a href="https://sobolevn.me"><img src="https://avatars1.githubusercontent.com/u/4660275?v=4" width="100px;" alt=""/><br /><sub><b>Nikita Sobolev</b></sub></a><br /><a href="#ideas-sobolevn" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3Asobolevn" title="Bug reports">🐛</a> <a href="https://github.com/nbQA-dev/nbQA/commits?author=sobolevn" title="Documentation">📖</a></td>
            <td align="center"><a href="https://www.linkedin.com/in/amichayoren/"><img src="https://avatars1.githubusercontent.com/u/48661380?v=4" width="100px;" alt=""/><br /><sub><b>Amichay Oren</b></sub></a><br /><a href="#ideas-amor71" title="Ideas, Planning, & Feedback">🤔</a></td>
            <td align="center"><a href="https://github.com/pylang"><img src="https://avatars0.githubusercontent.com/u/10778668?v=4" width="100px;" alt=""/><br /><sub><b>pylang</b></sub></a><br /><a href="#ideas-pylang" title="Ideas, Planning, & Feedback">🤔</a></td>
          </tr>
          <tr>
            <td align="center"><a href="http://iscinumpy.gitlab.io"><img src="https://avatars1.githubusercontent.com/u/4616906?v=4" width="100px;" alt=""/><br /><sub><b>Henry Schreiner</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3Ahenryiii" title="Bug reports">🐛</a></td>
            <td align="center"><a href="http://www.linkedin.com/in/kaiqidong"><img src="https://avatars0.githubusercontent.com/u/9269816?v=4" width="100px;" alt=""/><br /><sub><b>Kaiqi Dong</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/commits?author=charlesdong1991" title="Documentation">📖</a></td>
            <td align="center"><a href="http://simonbrugman.nl"><img src="https://avatars2.githubusercontent.com/u/9756388?v=4" width="100px;" alt=""/><br /><sub><b>Simon Brugman</b></sub></a><br /><a href="https://github.com/nbQA-dev/nbQA/issues?q=author%3Asbrugman" title="Bug reports">🐛</a></td>
          </tr>
        </table>
        
        <!-- markdownlint-enable -->
        <!-- prettier-ignore-end -->
        <!-- ALL-CONTRIBUTORS-LIST:END -->
        
        This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
        Contributions of any kind welcome!
        
Keywords: jupyter,notebook,format,lint
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
