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 typestub #15

Merged
merged 4 commits into from
May 15, 2020
Merged

Add typestub #15

merged 4 commits into from
May 15, 2020

Conversation

tamuhey
Copy link
Collaborator

@tamuhey tamuhey commented May 15, 2020

Based on PEP 561, I added type stubs into mojimoji.

The changes are as follows:

@tamuhey tamuhey requested a review from ikuyamada May 15, 2020 05:27
@ikuyamada ikuyamada merged commit 272c96e into master May 15, 2020
@ikuyamada
Copy link
Member

@tamuhey Thank you for your PR! Do you also plan to distribute mojimoji-stub package on PyPI?

@tamuhey tamuhey deleted the add_typestub branch May 16, 2020 05:48
@tamuhey
Copy link
Collaborator Author

tamuhey commented May 16, 2020

@ikuyamada Of course!
But according to PEP 561, mojimoji-stubs is automatically bundled in mojimoji when it is packaged, so there is no need to publish mojimoij-stubs separately.

PEP 561:

... the stubs can also be put in a separate package and distributed separately. Third parties can also find this method useful if they wish to distribute stub files. The name of the stub package MUST follow the scheme foopkg-stubs for type stubs for the package named foopkg. Note that for stub-only packages adding a py.typed marker is not needed since the name *-stubs is enough to indicate it is a source of typing information.

@tamuhey
Copy link
Collaborator Author

tamuhey commented May 16, 2020

So I want to release next version of mojimoji, what do you think? @ikuyamada

@ikuyamada
Copy link
Member

@tamuhey Thank you for the information and the contribution! It would be helpful for users to bundle the stub file, so I agree to release the next version of mojimoji.

@tamuhey
Copy link
Collaborator Author

tamuhey commented May 16, 2020

I tried it with test pypi but it didn't work.
I'm sorry I misunderstood somthing.
I'll fix it in another PR.

@tamuhey tamuhey mentioned this pull request May 16, 2020
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.

2 participants