feat: Add package data configuration and include py.typed file#8
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary ( closes #7 )
Adds
py.typedsupport to officially declare thatcaesarcipher_extendedships with inline type annotations and is compatible with PEP 561.This improves static analysis support for users of the package and enables better integration with modern Python tooling such as type checkers, IDEs, and autocomplete systems.
Changes
Added
py.typedmarker file inside:src/caesarcipher_extended/Packaging
py.typedin built distributionsTyping Support
This allows external tools to recognize the package as typed, including:
Why This Is Needed
Without
py.typed, Python type checkers may treat the package as untyped even when inline type annotations exist.Adding this marker:
Impact
This change is non-breaking and does not affect runtime behavior.
It only improves tooling and typing metadata support for consumers of the library.
References