Request: Explain the difference between `types-boto3`, `boto3-stubs` and `mypy-boto3`

youtype / mypy_boto3_builder

Type annotations builder for boto3 compatible with VSCode, PyCharm, Emacs, Sublime Text, pyright and mypy.

https://youtype.github.io/mypy_boto3_builder/

MIT License

544 stars 36 forks source link

Request: Explain the difference between `types-boto3`, `boto3-stubs` and `mypy-boto3` #314

Closed Avasam closed 1 month ago

Avasam commented 1 month ago

It's not clear to me which distribution I should be using if I want stubs for the boto3 package.

My first assumption is that the 3 packages should essentially be the same, but the metadata (including the description) slightly differ in each and there's no explanation why.

Looks like types-* is created to be similar to typeshed's notation, mypy-* for users who might be searching "mypy boto3" and boto3-stubs the most canonical package (as it will have the same name as the package doesn't look like it's coming from typeshed)

Looking at https://github.com/youtype/.github/blob/main/profile/README.md I wanna say boto3-stubs

vemel commented 1 month ago

Hello! Yes, it makes sense to clarify it in README and package description on PyPI.

boto3-stubs - main package, provides all AWS services as extras. this is the only package that I recommend to install in project's documentation
types-boto3 - proxy package to install boto3-stubs, created to be similar to typeshed
mypy-boto3 - another proxy package. I added it to replace old package that was needed to generate dynamic parts on typ annotations. No longer needed.

I think I will update description on PyPi for types-boto3 and mypy-boto3.

Avasam commented 1 month ago

Thanks for the answer! Going for boto3-stubs as I originally guessed then.

vemel commented 1 month ago

I will keep this issue open until I change readmes.