Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: PEP-561 compliance #237

Merged
merged 1 commit into from
Dec 9, 2020
Merged

feat: PEP-561 compliance #237

merged 1 commit into from
Dec 9, 2020

Conversation

gmcrocetti
Copy link
Contributor

#221:

Description of changes:

Add py.typed into package folder and include into pyproject.toml.

Checklist

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@heitorlessa heitorlessa added the feature New feature or functionality label Dec 9, 2020
heitorlessa
heitorlessa approved these changes Dec 9, 2020
View reviewed changes
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks straightforward enough - Thank you @gmcrocetti !!!

@heitorlessa heitorlessa merged commit 525c5fd into aws-powertools:develop Dec 9, 2020
TeoZosa added a commit to TeoZosa/cookiecutter-cruft-poetry-tox-pre-commit-ci-cd that referenced this pull request Jan 17, 2021
@TeoZosa
✨ Package and distribute type information
e8e8691 
From [Hypermodern Python Cookiecutter](https://cookiecutter-hypermodern-python.readthedocs.io/en/2020.6.15/guide.html?highlight=py.typed#the-initial-package):
"`py.typed` is an empty marker file, which declares that your package
supports typing and is distributed with its own type information (PEP
561). This allows people using your package to type-check their Python
code against it."

See:
- [PEP-561](https://www.python.org/dev/peps/pep-0561/)
- [Reference implementation: `aws-lambda-powertools-python`](aws-powertools/powertools-lambda-python#237)
- [Implementation Explanation](python-poetry/poetry#1338 (comment))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@heitorlessa heitorlessa heitorlessa approved these changes

Assignees
No one assigned
Labels
feature New feature or functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gmcrocetti @heitorlessa