Support PEP 561 Distributing and Packaging Type Information (py.typed marker)
Nobody has claimed this yet.
- #32 by @Anurag-S1ngh — closed without merging
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 60/100
Research direction
Start by reading the current pip_requirements_parser.py layout and the PEP 561 requirements for distributing py.typed. Check how the package is built and imported before evaluating the module-to-package rewrite; done means the installed package exposes its type information while preserving existing imports, with Mypy coverage considered separately.
Written by the indexing model from the issue text.
Description
Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing.
The package already has type annotations correctly in most places. In order for users of the package to have seamless type-checking, a py.typed marker is required.
Optionally, type checking using Mypy can be introduced to verify correctness of the public API.
There's a minor note in the PEP:
This PEP does not support distributing typing information as part of module-only distributions or single-file modules within namespace packages.
Which means the module will need to be rewritten from pip_requirements_parser.py to pip_requirements_parser/__init__.py.
I'm open to submit a PR; in case there's some budget to review/release.
- 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 ·
-
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
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/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