=====================
Command-line examples
=====================

.. note::
   Cell numbers in the output refer to code cells, enumerated starting from 1.

Reformat your notebooks with `black`_:

.. code:: console

   $ nbqa black my_notebook.ipynb
   reformatted my_notebook.ipynb
   All done! ✨ 🍰 ✨
   1 files reformatted.

Run your docstring tests with `doctest`_:

.. code:: console

   $ 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`_:

.. code:: console

   $ 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

Sort your imports with `isort`_:

.. code:: console

   $ nbqa isort my_notebook.ipynb
   Fixing my_notebook.ipynb

Check your type annotations with `mypy`_:

.. code:: console

   $ 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"

Perform static code analysis with `pylint`_:

.. code:: console

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

Upgrade your syntax with `pyupgrade`_:

.. code:: console

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

Format code with `yapf`_:

.. code:: console

   $ nbqa yapf --in-place my_notebook.ipynb

Format code with `autopep8`_:

.. code:: console

   $ nbqa autopep8 -i my_notebook.ipynb

Check docstring style with `pydocstyle`_:

.. code:: console

   $ nbqa pydocstyle my_notebook.ipynb

Format markdown cells with `blacken-docs`_:

.. code:: console

   $ nbqa blacken-docs my_notebook.ipynb --nbqa-md

Format ``.md`` file saved via `Jupytext`_ (note: requires ``jupytext`` to be installed):

.. code:: console

   $ nbqa black my_notebook.md

Perform linting on a notebook with `ruff`_:

.. code:: console

   $ nbqa ruff my_notebook.ipynb

you can also try to auto-fix reported issues via

.. code:: console

   $ nbqa ruff --fix my_notebook.ipynb

.. _black: https://black.readthedocs.io/en/stable/
.. _doctest: https://docs.python.org/3/library/doctest.html
.. _flake8: https://flake8.pycqa.org/en/latest/
.. _isort: https://timothycrosley.github.io/isort/
.. _Jupytext: https://github.com/mwouts/jupytext
.. _mypy: http://mypy-lang.org/
.. _pylint: https://github.com/PyCQA/pylint
.. _pyupgrade: https://github.com/asottile/pyupgrade
.. _yapf: https://github.com/google/yapf
.. _autopep8: https://github.com/hhatto/autopep8
.. _pydocstyle: http://www.pydocstyle.org/en/stable/
.. _blacken-docs: https://github.com/asottile/blacken-docs
.. _ruff: https://github.com/charliermarsh/ruff