bndr/pipreqs

Allow users to specify mapping overrides file via CLI flag

Open

#140 opened on Nov 9, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,545 stars) (368 forks)batch import
enhancementhelp wanted

Description

Currently, the only way to get pipreqs to work with a new mapping is to modify the mapping file and wait for a new release. Users should be able to specify a file that declares additional or override mappings. This file should use the same format as the existing mapping file. Inspired by #138.

Contributor guide

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.
2
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
PythonCLI tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Implement a new CLI flag, e.g., ` override mappings`, that accepts a file path to a mapping file in the same format as the existing mapping. Merge these mappings with the default ones. Update `argparse` setup and add tests. Refer to existing mapping file at `pipreqs/mapping.py` or similar.