Potential improvement for editable installs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start with pip-api's pip_api/_parse_requirements.py around line 248 and inspect how pip-requirements-parser represents EditableRequirement when no egg fragment is present. Define done as directory-based editable installs deriving the package name and version from setup.py instead of leaving req as None, with tests covering that case.
Written by the indexing model from the issue text.
Description
I noticed another small difference between pip-api and pip-requirements-parser which I'd like to bring up.
At the moment, pip-requirements-parser relies on an egg fragment being at the end of an editable install in order to infer its name/specifier. Otherwise, the EditableRequirement's req member is set to None.
pip-api has some special logic that checks whether the editable installation points to a directory. If so, it checks that directory for a setup.py and attempts to parse the package name and version out of the file. You can find the relevant logic here.
How do you feel about having this logic in pip-requirements-parser? I appreciate that this logic perhaps goes a bit beyond "parsing" but it'd be useful since not all editable requirements have an egg fragment.
- Dominant language
- Python
- Stars
- 20
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/pip-requirements-parser
-
Quadratic comment split on a requirements file line (pip_requirements_parser.py:1058)May be free again @Anurag-S1ngh claimed this 25 days ago, and no pull request is open. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
aboutcode-org/pip-requirements-parser#30 · 1 comment ·
-
Support PEP 561 Distributing and Packaging Type Information (py.typed marker)May be free again A pull request for this issue was closed without being merged. Open
Difficulty 4/5 3-5 days Newbie friendliness 60/100
-
Tests failures with packaging 26.0Possibly taken @s-t-e-v-e-n-k claimed this 290 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Doesn't support local paths to wheelsMay be free again @Anurag-S1ngh claimed this 18 days ago, and no pull request is open. Open
Difficulty 3/5 1-2 days Newbie friendliness 48/100
aboutcode-org/pip-requirements-parser#26 · 3 comments ·
-
[BUG] VCS URLs are detected as path on linux systemsMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
All issues in aboutcode-org/pip-requirements-parser
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
GoogleCloudPlatform/professional-services-data-validator#1899 ·
Maintainers usually reply within 4 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mohanraj00/entelos#200 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
sweep
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
bketelsen/truenas-mcp#77 ·
Maintainers usually reply within 1 day
-
Console writes URL credentials to the local log, though AGENTS.md says secrets never reach diskOpen
Difficulty 1/5 Under an hour Newbie friendliness 86/100
sandbox-quantum/switch#2163 ·
Maintainers usually reply within 1 day