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

Deprecate setup.py sdist, suggest and use replacement pypa/build based command #2875

Merged
merged 2 commits into from
May 31, 2024

Conversation

ankith26
Copy link
Member

We can use pypa/build to make an sdist file, now that we have the meson buildconfig.

I added a .gitattributes file, to skip a few files and ensure that the generated sdist is identical* to the one generated by setup.py sdist

* There is one point of difference, the docs/generated folder is included in the sdist generated by setup.py sdist, but not the pypa/build sdist. This is one of the things that will be taken care due to #2853 being merged.

PS: this PR also fixes a little bug in #2853 (so this is a sort of a successor PR to that)

@ankith26 ankith26 requested a review from a team as a code owner May 25, 2024 14:20
Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ankith26 ankith26 added this to the 2.5.0 milestone May 25, 2024
@Starbuck5
Copy link
Member

Starbuck5 commented May 31, 2024

If that's merged, how does it need taking care of? I don't understand.

I ran this locally and saw the generated docs weren't in the sdist.

@ankith26
Copy link
Member Author

I ran this locally and saw the generated docs weren't in the sdist.

Yes, that's intended. And the purpose of #2853 is to ensure that the setup docs command runs atleast once as part of the build process itself (and therefore, runs when the sdist is installed on the user side) so in the end, the user still has the generated docs as before.

Copy link
Member

@Starbuck5 Starbuck5 left a comment

Choose a reason for hiding this comment

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

Ok, checked that out and it works.

Cool!

@ankith26 ankith26 merged commit c178856 into main May 31, 2024
38 checks passed
@ankith26 ankith26 deleted the ankith26-meson-sdist branch May 31, 2024 08:16
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.

3 participants