Add py.typed marker file named to support type checking

[kirill-gr]

Fixes #39

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: kirill-gr / name: Kirill Grushetski (f291fa5)

[kirill-gr]

@kapilt would you mind taking a look?

[kapilt]

an empty file resolves the error?

[kirill-gr]

Yes, see: https://peps.python.org/pep-0561/#packaging-type-information

Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing.

[inikolaev]

Where are examples from other popular libraries that make use of py.typed:

• httpx an async HTTP client
• dd-trace-py a DataDog tracing library

[kapilt]

Totally understand the value, but the pr at the moment adds an empty file, which seems somewhat superfluous to the goal

…

On Sat, Jun 10, 2023 at 5:02 AM Igor Nikolaev ***@***.***> wrote: Where are examples from other popular libraries that make use of py.typed: - httpx <https://github.com/encode/httpx/blob/master/httpx/py.typed> an async HTTP client - dd-trace-py <https://github.com/DataDog/dd-trace-py/blob/1.x/ddtrace/py.typed> a DataDog tracing library — Reply to this email directly, view it on GitHub <#40 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAFJEXPDY6WBUAO6ETWNUTXKQZ2RANCNFSM6AAAAAAW3WPCHI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[inikolaev]

Apparently that is how it needs to be done to enable type checker to understand that the package supports types as per spec and as you can see from example projects.

Do you see that anything else needs to be done as part of of this PR? I had an impression the package already uses type annotations it just that they are not being used by mypy because of the missing marker file.

How do you propose to solve this?

[kapilt]

lgtm

[kapilt]

thanks for the additional context re other project links