Typehints / stubs

[PedroPerpetua]

Are there any plans to add type stubs to this project?

[Andrew-Chen-Wang]

Would love stubs typehints, but I don't have time to add anything for next few months, only maintenance. PRs welcome!

[abczzz13]

I would be happy to help with this.

(actually, I already started on this and accidentally created a PR to the the main repo instead of my fork, which in turn started running the tests. Deleted the PR shortly after).

However, please note that I have limited experience with contributing to opensource libraries. Let me know if you would be willing to take a look at the PR.

[Andrew-Chen-Wang]

happy to look and offer suggestions in the PR:) thanks for contributing

[PedroPerpetua]

Bumping this issue @Andrew-Chen-Wang - I see @abczzz13 already did great work and finished the typehints, merged in #683; however, there appears to be missing a py.typed file. Linters like mypy use this file to denote that a certain package has type hints. This is easily fixed by adding an empty py.typed file to the package, and making sure it's shipped when installed with pip.

Relevant PEP: https://peps.python.org/pep-0561/#packaging-type-information

After this has been fixed, this topic can be closed I believe :)

[Andrew-Chen-Wang]

I cannot commit directly. Kindly open a PR with the file py.typed so that I can merge

[PedroPerpetua]

I cannot commit directly. Kindly open a PR with the file py.typed so that I can merge

PR has been submited, #760