README.md

lduran2 / git-clean-each-ipynb

forked from lduran2/cis4526-machine_learning_foundations

configures the filters and .gitignores for cleaning Jupyter notebooks.

How to download

Add this module to your repo from its root directory by using

git submodule add https://github.com/lduran2/git-clean-each-ipynb filters/clean-each-ipynb

This command will download update git-clean-each-ipynb to filters/clean-each-ipynb, and update .gitmodules to associate the submodule.

How to install

Requirements

In Windows

Installing requires use of the git command within a bash shell. Allowing access to the git command, requires an extra step in Windows operating systems. Namely, it requires adding %git%/bin to the %PATH% variable where %git% represents the directory of the Git installation. This depends on the location of Git and the operating system, but may appear as follows

PATH=C:\git\bin;%PATH%

where the assumed location of the Git installation is C:\git.

Instructions

Then install it in the repo by using

bash filters/clean-each-ipynb/git-setup-filters

Note: This was changed from git-config-filters.

This script updates .gitignore to ignore Jupyter Notebook checkpoints (.ipynb_checkpoints/ directories) and .gitattributes to associate *.ipynb files with the eponymous ipynb filter. It also associates the clean ipynb filter with the filter program main in the root directory of this module.

Only configure the filter

To configure the filter without changing .gitignore or .gitattributes, use

bash filters/clean-each-ipynb/git-config-filters