Metadata-Version: 2.1
Name: nb-code-formatter
Version: 0.1.1
Summary: code formatter for ipynb files
Home-page: https://github.com/drillan/nb-code-formatter
Author: driller
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: black (>=22.3.0,<23.0.0)
Requires-Dist: isort (>=5.10.1,<6.0.0)
Requires-Dist: nbformat (>=5.4.0,<6.0.0)
Project-URL: Repository, https://github.com/drillan/nb-code-formatter
Description-Content-Type: text/x-rst

nb-code-formatter
=================

code formatter for ipynb files.

this tool uses `Black <https://github.com/psf/black>`_ for formatting code and `isort <https://github.com/PyCQA/isort>`_ for sorting imports.

Quick Start
-----------

Install the package
^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

    pip install nb-code-formatter

format code your ipynb file
^^^^^^^^^^^^^^^^^^^^^^^^^^^

overwrite existing notebook file

.. code-block:: bash

    nbcodefmt your_notebook.ipynb

write to new notebook file

.. code-block:: bash

    nbcodefmt your_notebook.ipynb new_notebook.ipynb

