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 (90 forks)batch import
help wantedtype:enhancement

Repository metrics

Stars
 (1,047 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the current install implementation in nbstripout, understand how arguments are parsed using argparse, modify the installation function to store flags like keep count and keep output in the git config filter and diff commands.
Tech stack
python
Domain
clitooling
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65