kynan/nbstripout

Read config from `setup.cfg`

Open

#166 opened on Aug 9, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (1,047 stars) (90 forks)batch import
help wantedstate:pr pendingtype:enhancement

Description

Would be cool if config options could be specified in setup.cfg so that they apply both when called from CLI and via pre-commit.

# setup.cfg

[nbstripout]
drop_empty_cells = true

Contributor guide

Tech stack
python
Domain
backendtooling
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Pythonsetup.cfgpre commit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate how nbstripout currently reads configuration (likely from CLI args or environment) and how `setup.cfg` is parsed by Python tools like `setuptools` or `configparser`. Look at similar projects that support `setup.cfg` for reference (e.g., `flake8`, `isort`). The resolution should involve adding a config parser that reads the `[nbstripout]` section from `setup.cfg` and merges it with CLI options. Explore how pre commit hooks invoke nbstripout to ensure the config is applied there as well. The issue has no linked PR, so implementation is open.