Skip to content

feat: Add package data configuration and include py.typed file#8

Merged
ViratiAkiraNandhanReddy merged 1 commit into
mainfrom
develop
May 16, 2026
Merged

feat: Add package data configuration and include py.typed file#8
ViratiAkiraNandhanReddy merged 1 commit into
mainfrom
develop

Conversation

@ViratiAkiraNandhanReddy

Copy link
Copy Markdown
Owner

Summary ( closes #7 )

Adds py.typed support to officially declare that caesarcipher_extended ships 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

  • Added py.typed marker file inside:
    src/caesarcipher_extended/

Packaging

  • Updated package configuration to include py.typed in built distributions

Typing Support

This allows external tools to recognize the package as typed, including:

  • mypy
  • Pyright
  • Pylance
  • other PEP 561 compatible tooling

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:

  • improves developer experience
  • enables better autocomplete
  • improves static analysis
  • provides proper typed-package support
  • aligns the project with modern Python packaging standards

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

  • PEP 561
  • Python typed package distribution standards

@ViratiAkiraNandhanReddy ViratiAkiraNandhanReddy added documentation Improvements or additions to documentation enhancement New feature or request labels May 16, 2026
@ViratiAkiraNandhanReddy ViratiAkiraNandhanReddy merged commit 36c85ad into main May 16, 2026
1 check failed
@github-project-automation github-project-automation Bot moved this from Todo to Done in CaesarCipher.extended May 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Add py.typed marker for PEP 561 typing support

1 participant