Skip to content

Add MyPy checks and py.typed to enable typings support #174

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

Closed
4 tasks done
xSAVIKx opened this issue Jul 11, 2022 · 0 comments · Fixed by #207
Closed
4 tasks done

Add MyPy checks and py.typed to enable typings support #174

xSAVIKx opened this issue Jul 11, 2022 · 0 comments · Fixed by #207
Assignees
Labels
enhancement New feature or request

Comments

@xSAVIKx
Copy link
Member

xSAVIKx commented Jul 11, 2022

While we already have some typings available it may be beneficial to configure MyPy in order to ensure type safety of the codebase as well as add the py.typed file to the repo to allow dependent projects to rely on the provided typings.

I'd say the following items should be covered:

  • Add MyPy pre-commit hook to run MyPy automatically.
  • Add all missing typings across the repository.
  • Add py.typed into the module root.
  • Ensure the MyPy check is required by the CI to merge PRs.
@xSAVIKx xSAVIKx added the enhancement New feature or request label Jul 11, 2022
@xSAVIKx xSAVIKx self-assigned this Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant