Vinyzu / Vinyzu/Botright

Add `py.typed` file for type hints

Open
#71 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement question
Dominant language
Python
Stars
1k
Forks
85
PR merge metrics
No merged PRs in 30d

Description

This project is beautifully (and fully) type-hinted, which is sort of wasted since neither mypy nor pyright will recognize them without a py.typed file at the package root. It can be just an empty, touch file.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the package root identified in the issue and review how the Python package is laid out. Add the empty py.typed marker file so mypy and pyright recognize the bundled type hints; done means the file is included at the package root and the package remains installable.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.