Modernize the packaging setup via PEP 621 and Hatch. #957
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #957 +/- ##
=======================================
Coverage 96.88% 96.88%
=======================================
Files 20 20
Lines 3276 3276
Branches 449 449
=======================================
Hits 3174 3174
Misses 79 79
Partials 23 23 Continue to review full report at Codecov.
|
Julian
force-pushed
the
hatch
branch
3 times, most recently
from
d87f32f
to
9602996
Compare
Doing so jettisons setuptools in favor of a more modern, well-designed, legacy-free, and now well-supported packaging tool, Hatch. No end-user facing behavior changes are expected for any users using a recent packaging setup (within the past 2-3 years), so please report any issues. Hatch: https://hatch.pypa.io/latest/ PEP 621: https://peps.python.org/pep-0621/
And only run the latter after the former.
Some additional detail would be helpful, such as that this project (now) uses hatch, which is why it's on this branch, but this is a start.
sigprof
added a commit
to sigprof/nix-devenv-qmk
that referenced
this pull request
Jun 12, 2022
The `jsonschema` module switched the packaging system to Hatch since version 4.6.0 (python-jsonschema/jsonschema#957). The build process for `jsonschema` now requires the `hatchling` and `hatch-vcs` modules, but the used Nixpkgs snapshot does not include Nix packages for these modules; adding these modules to the `[tool.poetry.dev-dependencies]` section makes them available for the (upcoming) poetry2nix override without the need to bump the Nixpkgs snapshot. However, simply adding `hatchling` and `hatch-vcs` to dependencies produces some more dependency issues: 1) The `pytest` module in the used Nixpkgs snapshot is old and has a dependency for the `pluggy` module with an upper bound for the version, which creates a version conflict with the dependency of the `hatchling` module. Upgrading the `pytest` module to the current version fixes this compatibility issue. 2) The `tomli` module, which is in the dependency tree of `hatchling`, requires a newer `flit-core` module than found in the used Nixpkgs snapshot. Again, upgrading the `flit-core` module to the current version fixes the compatibility issue. When the Nixpkgs snapshot gets bumped in the future, this commit should probably be reverted (and `poetry.lock` should be regenerated to remove the unneeded dependencies).
sigprof
added a commit
to sigprof/nix-devenv-qmk
that referenced
this pull request
Jun 12, 2022
The `jsonschema` module switched the packaging system to Hatch since version 4.6.0 (python-jsonschema/jsonschema#957). The build process for `jsonschema` now requires the `hatchling` and `hatch-vcs` modules, which were made available to poetry2nix by the previous commits; add these modules to `nativeBuildInput` to fix the build.
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.
Doing so jettisons setuptools in favor of a more modern, well-designed,
legacy-free, and now well-supported packaging tool, Hatch.
No end-user facing behavior changes are expected for any users using a
recent packaging setup (within the past 2-3 years), so please report any
issues.
Hatch: https://hatch.pypa.io/latest/
PEP 621: https://peps.python.org/pep-0621/