Skip to content

Add py.typed to source folder #115

Open

Description

@bphunter1972

Is your feature request related to a problem? Please describe.
No. It will enable mypy to read the types.

Describe the solution you'd like
Add an empty file called py.typed to source folder.

Additional context
See PEP561 (https://mypy.readthedocs.io/en/stable/installed_packages.html#installed-packages)

Activity

  1. sheepfling commented on Oct 29, 2026

    @sheepfling

    I'd like to propose a typing contribution for this issue. The change would package py.typed in the source distribution and wheel, and correct annotations where the current runtime accepts inputs the existing types omit—for example, nested Markdown lists, non-string table cells, iterable alignments, and explicit None for optional arguments. It retains the advertised Python 3.6 floor and adds runtime and clean installed-wheel consumer checks.

    I've prepared a branch for review: https://github.com/sheepfling/mdutils/tree/typing/pep561-issue-115. The tests pass on Python 3.12, and the source parses with Python 3.6 grammar; I have not yet run the suite on Python 3.6. Some deeply pre-annotated nested lists remain limited by list invariance in type checkers.

    Would this scope be useful to the project, and would you welcome a draft pull request? I'm happy to adjust it to fit your preferred approach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions