Type hints & PEP 561 packaging
Open
Nobody has claimed this yet.
help-wanted
- Dominant language
- Python
- Stars
- 553
- Forks
- 177
- PR merge metrics
- No merged PRs in 30d
Description
Add type hints to all (public API) code make the distribution PEP 561 compliant. This allows mypy (and other tools?) to find the type hints and use them in linting.
In practice, add py.typed file to statsd package, and include it in the package:
setup(
package_data={'statsd': ['py.typed']},
zip_safe=False, # not needed with wheels, AFAIK
)
Contributor guide
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 reviewing the statsd package and its setup configuration, then read PEP 561 to confirm the packaging requirements. Add type hints to the public API and include a py.typed file in the distribution; done means type-checking tools can discover the package hints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100