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.

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

Add py.typed file to mark aioapcaccess as type-annotated #22

Merged
merged 1 commit into from
Nov 27, 2023

Conversation

yuxincs
Copy link
Owner

@yuxincs yuxincs commented Nov 27, 2023

Per PEP 561: "Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing"

Since aioapcaccess is fully typed, this PR adds a py.typed file at the root of the package to support type checking in downstream dependencies.

Note that we are using setuptools_scm plugin such that this file is automatically included in the final distribution package, without us having to explicitly specify it in pyproject.toml.

@yuxincs yuxincs merged commit fdd30aa into main Nov 27, 2023
5 checks passed
@yuxincs yuxincs deleted the yuxincs/add-py-typed-file branch November 27, 2023 00:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant