trentm / trentm/python-markdown2
Add py.typed marker
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.8k
- Forks
- 459
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 4
Description
When importing markdown2, I’m seeing the following linter warnings:
- mypy: Skipping analyzing "markdown2": module is installed, but missing library stubs or py.typed marker.
- Pyright: Stub file not found for "markdown2"
I noticed that typing support was introduced in PR #581 — thanks for that! I was wondering if there might be one additional step needed to make this fully recognized by type checkers.
From what I understand, adding a py.typed file to the package can help tools like mypy and Pyright detect that the package includes type information (as mentioned in #456 and #562). For reference, this might be helpful:
https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/
If this sounds reasonable and you would like to have support, I’d be happy to help.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by locating the packaged markdown2 module and the project’s packaging configuration, then check how package data is included in distributions. Done means a py.typed marker is shipped with markdown2 and mypy and Pyright no longer report the missing type-information warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100