awslabs / awslabs/aws-crt-python

Type hints & PEP 561 packaging

Open
#278 0 comments 7 reactions 0 assignees View on GitHub
feature-request p3
Dominant language
Python
Stars
100
Forks
58
Avg merge
13h 51m
Merged PRs (30d)
2

Description

Add type hints to all (at least public API) code make the distribution PEP 561 compliant. This allows `mypy` (and other tools?) to find the type hints and use them in linting.

In practice, add an empty `awscrt/py.typed` file, and include it in the package:

```py
setup(
package_data={'awscrt': ['py.typed']},
zip_safe=False, # not needed with wheels, AFAIK
)
```

PEP 561: https://www.python.org/dev/peps/pep-0561/

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.