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

Mark package as typed #241

Merged
merged 2 commits into from
Jan 9, 2025
Merged

Mark package as typed #241

merged 2 commits into from
Jan 9, 2025

Conversation

benoit74
Copy link
Collaborator

@benoit74 benoit74 commented Jan 9, 2025

Changes:

  • add a py.typed marker file to indicate that the library is typed (at top-level obviously)
  • fix sdist configuration (using include overrides the whole default logic of sdist content ; we only want to add few more files, which should be done with artifacts - just like for the wheel)

Nota: tested succesfully with mindtouch scraper which is now in strict type checking mode (on my dev machine, PR ongoing)

Using 'artifacts' instead of 'include' because we do not want to
interfere with standard include rules but rather add few more items.

Using 'include' causes the sdist to be mostly empty.
@benoit74 benoit74 added this to the 5.0.0 milestone Jan 9, 2025
@benoit74 benoit74 self-assigned this Jan 9, 2025
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e6a1a8a) to head (f8ac2a8).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #241   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           39        39           
  Lines         2455      2455           
  Branches       331       331           
=========================================
  Hits          2455      2455           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kelson42 kelson42 changed the title Mark pakcage as typed Mark package as typed Jan 9, 2025
@benoit74 benoit74 marked this pull request as ready for review January 9, 2025 09:53
@benoit74 benoit74 requested a review from rgaudin January 9, 2025 09:53
Copy link
Member

@rgaudin rgaudin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@benoit74 benoit74 merged commit b2afb65 into main Jan 9, 2025
9 checks passed
@benoit74 benoit74 deleted the mark_as_typed branch January 9, 2025 10:41
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