Advertise typing support

pierre-24 / pyiso4

Implementation of the ISO 4 standard for journal titles abbreviations in Python.

MIT License

4 stars 2 forks source link

Advertise typing support #10

Closed alexfikl closed 6 months ago

alexfikl commented 6 months ago

The main point of this was to add a py.typed marker so that users can get the typing annotations.

To make sure that all works nicely, it also

Adds a barebones mypy configuration
Adds a mypy step to the CI
Fixes all the reported issues by mypy --strict.

alexfikl commented 6 months ago

Thank you, I did not know that it existed. There are small things to correct (thanks for correcting the lint error, btw), but we're almost good to go :)

Thanks for the very quick reply! Yeah, adding a py.typed empty file is required to let other packages know they can use the typing information: https://peps.python.org/pep-0561/#packaging-type-information

pierre-24 commented 6 months ago

Thank you :)

alexfikl commented 6 months ago

Thank you for the quick review! :grin: