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 (368 forks)batch import
enhancementhelp wantedmapping

Repository metrics

Stars
 (5,545 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Modify the mapping file logic to use pkg resources.Requirement.parse to extract the package name from extras requirements (e.g., requests[security]) before querying the package index. Then, during serialization, include the extras back in the requirement string. Look at existing mapping file handling in the codebase and follow the pattern.
Tech stack
python
Domain
devtools
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonsetuptools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70