kynan/nbstripout

Persist additional options / flags in the config on `--install`

Open

#150 opened on Apr 23, 2021

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (1,047 stars) (90 forks)batch import
help wantedtype:enhancement

Description

e.g. nbstripout --install --keep-count should put the --keep-count flag in the resultant git config filter.nbstripout.clean and git config diff.ipynb.textconv commands.

This applies to:

  • --keep-count
  • --keep-output

Contributor guide

Tech stack
pythonshell
Domain
devopstooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of nbstripout's install commandunderstanding of git configPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The main task is to modify the install function (likely in nbstripout.py) to parse additional flags keep count and keep output from the command line and pass them into the git config commands. Review existing tests for install and update accordingly. Also ensure backward compatibility.