UCL-ARC / UCL-ARC/python-tooling
Add a `py.typed` file to the template
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 62
- Forks
- 10
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 6
Description
Is Your Feature Request Related to a Problem? Please Describe
We are encouraging typing through the use of mypy already, it makes sense that we include the file by default https://safjan.com/the-importance-of-adding-py-typed-file-to-your-typed-package
Describe the Solution You'd Like
Add a py.typed file
Describe Alternatives You've Considered
No response
Additional Context
No response
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 in the cookiecutter project template, using the referenced .pre-commit-config.yaml and its package layout to identify where package metadata files belong. Add the empty py.typed marker there and verify that a newly generated project includes it in the package; the template's existing checks should still pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100