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.

Sign up for GitHub

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

Jump to bottom

MRG: Use hatchling as build backend #1204

Merged
merged 12 commits into from
Dec 7, 2023
Merged

MRG: Use hatchling as build backend #1204

merged 12 commits into from
Dec 7, 2023

Conversation

hoechenberger
Copy link
Member

@hoechenberger hoechenberger commented Dec 7, 2023 •
edited
Loading

Also dynamically generate version number via hatch-vcs

Addresses #1174

cc @ofek

Merge checklist

Maintainer, please confirm the following before merging.
If applicable:

  • All comments are resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated

@hoechenberger
Use hatchling as build backend
fdbf6eb 
Also dynamically generate version number via hatch-vcs

Addresses mne-tools#1174
@hoechenberger hoechenberger marked this pull request as draft December 7, 2023 17:35
@codecov Codecov
Copy link

codecov bot commented Dec 7, 2023 •
edited
Loading

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (e6ca823) 97.63% compared to head (3800913) 97.61%.

Files Patch % Lines
mne_bids/__init__.py 60.00% 2 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1204      +/-   ##
==========================================
- Coverage   97.63%   97.61%   -0.03%     
==========================================
  Files          40       40              
  Lines        8681     8685       +4     
==========================================
+ Hits         8476     8478       +2     
- Misses        205      207       +2

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

@hoechenberger hoechenberger marked this pull request as ready for review December 7, 2023 18:06
@hoechenberger hoechenberger mentioned this pull request Dec 7, 2023
Closed
@hoechenberger hoechenberger changed the title Use hatchling as build backend MRG: Use hatchling as build backend Dec 7, 2023
sappelhoff
sappelhoff reviewed Dec 7, 2023
View reviewed changes
doc/whats_new.rst Outdated
- nothing yet
- The package build backend has been switched from ``setuptools`` to ``hatchling``. This
only affects users who build and install MNE-BIDS from source, and should not lead to
changed runtime behavior, by `Richard Höchenberger`_ (:gh:`1204`)
Copy link
Member

Choose a reason for hiding this comment

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

in what ways does it affect users who build and install mne-bids from source? :)

Copy link
Member Author

Choose a reason for hiding this comment

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

The build process is simply different now. Maybe it should be phrased differently? No user intervention is required

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure it should be in the release notes then🤔 usually we skip "infrastructure changes without effect on the user", don't we?

Copy link
Member Author

Choose a reason for hiding this comment

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

There should be a Code Health section like we have in MNE-BIDS-Pipeline.

Copy link
Member Author

Choose a reason for hiding this comment

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

MS does the same for the VS Code Python extension

image

sappelhoff
sappelhoff reviewed Dec 7, 2023
View reviewed changes
pyproject.toml Outdated
@@ -80,7 +74,7 @@ doc = [
"mne-nirs @ https://github.com/mne-tools/mne-nirs/archive/refs/heads/main.zip",
"seaborn",
"openneuro-py",
"defusedxml", # for reading BrainVision montages: `examples/convert_eeg_to_bids.py`
"defusedxml", # for reading BrainVision montages: `examples/convert_eeg_to_bids.py`
Copy link
Member

Choose a reason for hiding this comment

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

is this is mistake or by design? if by design, why?

Copy link
Member Author

Choose a reason for hiding this comment

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

My linter adds this automatically... but I can change it

Otherwise number of spaces before an inline comment in TOML is just 1

Copy link
Member Author

Choose a reason for hiding this comment

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

Btw the linter I use comes with the Even Better TOML extension for VS Code

Very helpful tool really

sappelhoff
sappelhoff reviewed Dec 7, 2023
View reviewed changes
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

in general, I think this is nice -- thanks for adding it!

It would also need updates to the release protocol in the WIKI

sappelhoff
sappelhoff approved these changes Dec 7, 2023
View reviewed changes
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

+1 to merge if:

We can update the release protocol separately.

Thanks!!

@hoechenberger
Copy link
Member Author

Thanks
Will do later tonight

@hoechenberger
Copy link
Member Author

@sappelhoff I think we're good to go

@hoechenberger hoechenberger enabled auto-merge (squash) December 7, 2023 21:15
ofek
ofek approved these changes Dec 7, 2023
View reviewed changes
Copy link

@ofek ofek left a comment

Choose a reason for hiding this comment

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

LGTM

sappelhoff
sappelhoff reviewed Dec 7, 2023
View reviewed changes
doc/whats_new.rst Outdated Show resolved Hide resolved
@hoechenberger hoechenberger merged commit ee9efd9 into mne-tools:main Dec 7, 2023
16 of 18 checks passed
@hoechenberger hoechenberger deleted the hatchling branch December 7, 2023 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sappelhoff sappelhoff sappelhoff approved these changes

@ofek ofek ofek approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hoechenberger @sappelhoff @ofek