Skip to content

PEP-561 compliance: Mark jtd as typed with py.typed file #2

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

Open
ChristopherChudzicki opened this issue Mar 9, 2023 · 0 comments
Open

Comments

@ChristopherChudzicki
Copy link

When typechecking code that uses jtd with Mypy, Mypy complains that the package is untyped:

error: Skipping analyzing "jtd": module is installed, but missing library stubs or py.typed marker  [import]
note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
Found 1 error in 1 file (checked 13 source files)

Mypy version 1.0.0, Python 3.11.2

Looking at the source code in this repository, it clearly has type annotations, but Mypy isn't picking them up.

Based on https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages, I think the project should have a py.typed file adjacent to setup.py. (And setup.py should mention it as part of package_data).


Thanks for jtd; I've been enjoying it!

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

No branches or pull requests

1 participant