bndr/pipreqs

Support requirement extras in mapping file

Open

#103 opened on Oct 26, 2017

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (5,545 stars) (368 forks)batch import
enhancementhelp wantedmapping

Description

Per #61, it's occasionally useful to be able to use an extras requirement (e.g. requests[security] or scikit-learn[alldeps]). This can be accomplished using Requirement objects and the Requirement.parse method to extract the name prior to performing a search against the package index API and to add it back during the serialization step.

Contributor guide

Tech stack
python
Domain
tooling
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
Python knowledgeFamiliarity with pipreqsUnderstanding of Requirement objects
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Start by reading the linked issue #61 for context. Then, examine the mapping file (likely in `pipreqs/mapping.py`) and use `pkg resources.Requirement.parse` to extract the package name from entries like `requests[security]`. Modify the search and serialization steps to preserve the extras string.