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
PEP 561 compliance #17
Conversation
0268655
to
7c9e974
Compare
Codecov Report
@@ Coverage Diff @@
## master #17 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 72 73 +1
Branches 6 6
=========================================
+ Hits 72 73 +1
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! Two general comments:
- I believe there's an extra step you need to do to make sure
py.typed
shows up in our dists, maybe add toMANIFEST.in
? - Within
ci/travis.sh
can you add a step inCHECK_FORMATTING
that runs mypy on the file?
And I don't think a newsfragment is necessary, this project doesn't require a ton of updates to be coordinated :)
Ah yes, of course - I've gotten used to Poetry, which just automagically makes this kind of thing work!
Can do. |
7c9e974
to
30137f9
Compare
30137f9
to
6bfdea9
Compare
Hey @tomwatson1024, it looks like that was the first time we merged one of your PRs! Thanks so much! 🎉 🎂 If you want to keep contributing, we'd love to have you. So, I just sent you an invitation to join the python-trio organization on Github! If you accept, then here's what will happen:
If you want to read more, here's the relevant section in our contributing guide. Alternatively, you're free to decline or ignore the invitation. You'll still be able to contribute as much or as little as you like, and I won't hassle you about joining again. But if you ever change your mind, just let us know and we'll send another invitation. We'd love to have you, but more importantly we want you to do whatever's best for you. If you have any questions, well... I am just a humble Python script, so I probably can't help. But please do post a comment here, or in our chat, or on our forum, whatever's easiest, and someone will help you out! |
Thanks for these changes! Will prepare a 1.2.0 release :) |
Add type hints and a 'py.typed' marker file (see PEP 561) to allow type checking in dependent code.
I've not added any automatic type checking or anything - I have run
mypy
over the code to confirm that my type hints are correct, though.Not sure if this qualifies for a news fragment - happy to write one if necessary.