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

Simplify single source #1580

Merged
merged 50 commits into from
Aug 24, 2024
Merged

Conversation

ChrisBarker-NOAA
Copy link
Contributor

@ChrisBarker-NOAA ChrisBarker-NOAA commented Aug 1, 2024

I'm no longer calling this a WIP -- I hope it's close to as good as it's going to get.

This is a follow-up to #1578 -- I made a mess of it when I tried to rebase.

The goal here is to have a simple, and not opinionated, page that guides folks to their build tool of choice's way to handle version strings.

Not sure if it's a guide or a discussion -- I put in discussion, but maybe it's more of a guide.

Now that I think about it -- if it's in discussions, then maybe it could be a lot longer, and go into why one might want to (or not want to) provide a version attribute in the importable package.

But I don't know that I want to moderate THAT discussion…


📚 Documentation preview 📚: https://python-packaging-user-guide--1580.org.readthedocs.build/en/1580/discussions/single-source-version/

ChrisBarker-NOAA and others added 20 commits July 31, 2024 16:42
refering folks to their build system of choice.
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
@webknjaz
Copy link
Member

@ChrisBarker-NOAA have you looked into the possibility of embedding a diagram? (#1276 (comment))
I think, it's important to demonstrate unidirectional flow of the version sourcing.

@ChrisBarker-NOAA
Copy link
Contributor Author

OK -- I think this is in good shape, and has addressed the concerns of everyone.

Open Question: whether to include a diagram -- see: #1580 (comment)

Other than that -- good to go.

Editors -- anything else?

ChrisBarker-NOAA and others added 3 commits August 22, 2024 12:17
Co-authored-by: Anderson Bravalheri <andersonbravalheri [email protected]>
Co-authored-by: Anderson Bravalheri <andersonbravalheri [email protected]>
Co-authored-by: Anderson Bravalheri <andersonbravalheri [email protected]>
@webknjaz
Copy link
Member

Open Question: whether to include a diagram -- see: #1580 (comment)

Thanks for acknowledging that you saw my request. What's your opinion? I don't think I saw you sharing it anywhere — have I missed it?

@bwoodsend
Copy link
Contributor

What would the diagram contain? I'm guessing some flow that depicts pyproject.toml -> build backend -> project/__init__.py:__version__ -> version in package metadata? Not sure how I'd translate those into picture form short of just writing those words with rectangles round them.

@ChrisBarker-NOAA
Copy link
Contributor Author

Open Question: whether to include a diagram --
What's your opinion?

I don't think it's necessary -- it's just not that complicated.

But I'm happy for the doc editor(s) to decide.

-CHB

@webknjaz
Copy link
Member

@bwoodsend I made a diagram in this comment a while back: #1276 (comment). I imagined it'd be reused, maybe with some modifications. It's made with Mermaid.

@ChrisBarker-NOAA okay, I hear you. In the interest of unblocking the effort, I withdraw that request for now.

@webknjaz webknjaz added this pull request to the merge queue Aug 24, 2024
Merged via the queue into pypa:main with commit afb69f3 Aug 24, 2024
5 checks passed
@flying-sheep
Copy link
Contributor

Thanks for slogging through all our comments, I think the end result is really nice and clear now!

@ChrisBarker-NOAA
Copy link
Contributor Author

Glad it got through to the end this time!

Thanks all -- it was a slog, but it's a much better document as a result of all the input.

@bwoodsend
Copy link
Contributor

Here's to never seeing FileNotFoundError: .../site-packages/xyz/version.txt ever again!

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.

6 participants