Modify the pyprojetc.toml (possibly incorrectly) #1474
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hatch uses hatchling as the underlying build system. With older versions of hatchling the metadata is out of date with the expected metadata for pypi (something to do with the license file -- I'm not entirely sure what). The way to build the dist with hatch/hatchling: ``` hatch build ``` You can check the Metadata version with: ``` tar -xzf dist/axelrod-*.tar.gz cat axelrod-*/PKG-INFO | grep "Metadata-Version" ``` THIS SHOULD give you: ``` Metadata-Version: 2.4 ``` Once that's done, assuming the auth is set up correctly you publish with ``` hatch publish ``` While I was fixing all this I was changing the pyproject.toml file. We should open an issue to possibly put the license file back in and also document the release process (essentially putting some of the information I'm writing here). For other projects of mine I have setup a publish worklow so that github actions takes care of this. We could look in to doing that as well.
|
Why does the license file have to be removed? |
|
Good question! Just to be clear — we’re not removing or changing the license itself. It’s still declared as MIT in pyproject.toml and the file remains in the repo. This was mainly a packaging quirk between hatch, hatchling, and pyproject.toml. The way we referenced the license file wasn’t compatible, and after a fair bit of trial and error (which I could only debug in the final step of uploading to PyPI), I landed on this fix. I suggest we revisit this for the next release and try adding the file path back — we should open an issue to track it (or perhaps turn this PR in to that issue). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
Hatch uses hatchling as the underlying build system.
With older versions of hatchling the metadata is out of date with the expected metadata for pypi (something to do with the license file -- I'm not entirely sure what).
The way to build the dist with hatch/hatchling:
You can check the Metadata version with:
THIS SHOULD give you:
Once that's done, assuming the auth is set up correctly you publish with
Proposed actions
While I was fixing all this I was changing the pyproject.toml file.
We should open an issue to possibly put the license file back in and also document the release process (essentially putting some of the information I'm writing here).
For other projects of mine I have setup a publish worklow so that github actions takes care of this. We could look in to doing that as well.