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

Add migration guide #356

Merged
merged 12 commits into from
Jun 21, 2023
Merged

Add migration guide #356

merged 12 commits into from
Jun 21, 2023

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Jun 2, 2023

Adding a page to the documentation about migrating from scikit-build classic. I'll keep updating this as I discover more while migrating various repos, then open it for review when I've found everything I expect to find.

docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
@henryiii
Copy link
Collaborator

henryiii commented Jun 3, 2023

If it helps, I've recently helped wjakob/nanobind_example and kratsg/pylibmagic#48 convert. There's a PR to scikit-build/cmake_python_distributions too.

@vyasr
Copy link
Contributor Author

vyasr commented Jun 6, 2023

Thanks for the review @henryiii! Before I go any further, do you agree that something like this guide could be helpful? Happy to continue investing time in it if you're interested since I will be effectively compiling this list for my own use anyway.

If it helps, I've recently helped wjakob/nanobind_example and kratsg/pylibmagic#48 convert. There's a PR to scikit-build/cmake_python_distributions too.

Thanks for the pointer. I know there were a couple other early conversions too (like awkward array) that I could look at. FWIW I've got a handful of different projects that will all probably migrate roughly in lockstep, and while they are largely similar I'll probably be playing it safe and testing many/most of them before merging the migrations. So I may end up providing you with even more data points (not sure how many projects you already have on scikit-build-core now though!).

@henryiii
Copy link
Collaborator

henryiii commented Jun 7, 2023

Before I go any further, do you agree that something like this guide could be helpful

Sure! Eventually it might just be a guide for converting from setuptools (possibly + CMake manually added) though, once most projects have converted from scikit-build classic. But that's well in the future.

@LecrisUT
Copy link
Collaborator

LecrisUT commented Jun 8, 2023

There will also be a weird transition back when scikit-build will be calling scikit-build-core. Still confused on what that difference will end up being later on.

@henryiii
Copy link
Collaborator

henryiii commented Jun 8, 2023

It will try to behave like the old scikit-build, though, and it still will work through setuptools (which is not ideal); a lot of the features you don't get access to (like auto cmake/ninja download) unless you switch to the new interface.

@vyasr vyasr requested a review from henryiii June 14, 2023 20:39
@vyasr vyasr marked this pull request as ready for review June 14, 2023 20:39
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
docs/migration_guide.md Outdated Show resolved Hide resolved
vyasr and others added 2 commits June 21, 2023 14:57
@vyasr vyasr force-pushed the doc/migration_guide branch from 4cb7b49 to 668fb4e Compare June 21, 2023 19:00
@vyasr vyasr requested a review from henryiii June 21, 2023 19:00
docs/migration_guide.md Outdated Show resolved Hide resolved
@vyasr vyasr requested a review from henryiii June 21, 2023 21:54
@henryiii henryiii enabled auto-merge (squash) June 21, 2023 23:00
@henryiii henryiii merged commit dd4cc0a into scikit-build:main Jun 21, 2023
@henryiii
Copy link
Collaborator

Thanks!

@vyasr vyasr deleted the doc/migration_guide branch December 2, 2023 00:41
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.

3 participants