Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add py.typed #398

Closed
wants to merge 2 commits into from
Closed

Conversation

Goldziher
Copy link

This PR addresses #397, adding a py.typed to the package.

@Goldziher Goldziher changed the title chore: update setup.py chore: add py.typed Jan 31, 2025
Copy link
Contributor

@kurtmckee kurtmckee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. There isn't currently a py.typed file in the source tree. Did you test that the project can be built after adding this change?

  2. mypy isn't being run against the project in CI to confirm that the type annotations are coherent. Adding a py.typed file to claim that the project is typed isn't much of a claim without actually testing the type annotations.

I recommend modifying CI to run mypy against the project to confirm that the type annotations are coherent.

@Goldziher Goldziher closed this by deleting the head repository Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants