8000 MNT: Migrate project to flit-scm by ghisvail · Pull Request #597 · nipype/pydra · GitHub
[go: up one dir, main page]
Skip to content

MNT: Migrate project to flit-scm #597

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
Merged
merged 6 commits into from
Nov 28, 2022
Merged

MNT: Migrate project to flit-scm #597

merged 6 commits into from
Nov 28, 2022

Conversation

ghisvail
Copy link
Collaborator
@ghisvail ghisvail commented Nov 23, 2022 •
edited
Loading

Types of changes

  • Enhancement

Summary

With setup.py soon to become legacy in favour of the more declarative pyproject.toml, this PR proposes to migrate the project to Flit and perform dynamic versioning with flit-scm instead of versioneer.

The very same migration has been successfully experimented with in pydra-nipype1, which makes me confident the same can be achieved in the main Pydra repository. The main benefit is to future-proof project management – setup.py is going away sooner or later, better be safe than sorry when it happens.

Checklist

  • Convert project metadata to pyproject.toml
  • Convert dynamic versioning to flit-scm
  • Adjust CI workflows to the new build
  • Run the tests through CI

@ghisvail ghisvail force-pushed the mnt/flit-scm branch 3 times, most recently from abaa60c to 2138207 Compare November 23, 2022 10:09
@codecov
Copy link
codecov bot commented Nov 23, 2022 •
edited
Loading

Codecov Report

Base: 76.77% // Head: 76.81% // Increases project coverage by +0.04% 🎉

Coverage data is based on head (cd95d0d) compared to base (5bbb4a9).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #597      +/-   ##
==========================================
+ Coverage   76.77%   76.81%   +0.04%     
==========================================
  Files          19       19              
  Lines        4349     4357       +8     
  Branches     1193     1194       +1     
==========================================
+ Hits         3339     3347       +8     
  Misses        821      821              
  Partials      189      189
Flag Coverage Δ
unittests 76.72% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pydra/engine/audit.py 92.50% <0.00%> (+0.83%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ghisvail ghisvail force-pushed the mnt/flit-scm branch 5 times, most recently from 67246ef to 4837825 Compare November 23, 2022 10:57
@ghisvail
MNT: Migrate project to flit-scm
e7583e4
@ghisvail
MNT: Rename setup.cfg to .flake8
611ae10 
Flake8 does not support pyproject.toml yet (if ever?). Rename setup.cfg to
.flake8 to make it more explicit that the only concern left is flake8
configuration.
@ghisvail
CI: Update build steps in workflows
abfd9aa
@ghisvail
CI: Add configuration for readthedocs
36bb2de
@djarecka
Copy link
Collaborator

can this allow for installing with pip install -e .?

@ghisvail
Copy link
Collaborator Author

can this allow for installing with pip install -e .?

Yes, and also optional extras like pip install -e .[doc] or pip install -e .[test]

effigies
effigies approved these changes Nov 28, 2022
View reviewed changes
Copy link
Contributor
@effigies effigies left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks so much for taking the time.

A couple suggestions to restore some dropped "extras".

ghisvail and others added 2 commits November 28, 2022 20:36
@ghisvail @effigies
MNT: Add compatibility aliases
22264b7 
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
@ghisvail @effigies
MNT: Include test dependencies in dev group
cd95d0d 
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
@ghisvail ghisvail merged commit 27182bb into nipype:master Nov 28, 2022
@ghisvail ghisvail deleted the mnt/flit-scm branch November 28, 2022 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@effigies effigies effigies 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
@ghisvail @djarecka @effigies
0