chore: use Hatch to build package & support to `ipywidgets==8.x`

K3D-tools / K3D-jupyter

K3D lets you create 3D plots backed by WebGL with high-level API (surfaces, isosurfaces, voxels, mesh, cloud points, vtk objects, volume renderer, colormaps, etc). The primary aim of K3D-jupyter is to be easy for use as stand alone package like matplotlib, but also to allow interoperation with existing libraries as VTK.

MIT License

941 stars 123 forks source link

chore: use Hatch to build package & support to `ipywidgets==8.x` #378

Closed agoose77 closed 1 year ago

agoose77 commented 2 years ago

This PR:

Moves the build backend to hatchling, which is the new default for Jupyter extensions. Hatch is very easy to use, and it means we can drop some configuration.
Uses hatch-nodejs-version to source the package version and a subset of metadata from package.json. Updating the version before release can be done with hatch version <NEW_VERSION>
Adds support for ipwidgets>=8.0.0
Removes unneeded labextension data from k3d pacakge in built wheel.
Bumps Python version to >=3.7

Supersedes #377

agoose77 commented 2 years ago

@artur-trzesiok this changes the contents of the built wheel, so I would appreciate it if you could check that it looks right. I removed the labextension from the k3d package (for wheels), as it's only used during development by JupyterLab

artur-trzesiok commented 2 years ago

Hi!

Thanks for your contribution! Before I will merge PR I want to test in on my computer. Please give me a few extra days. I'm happy that community around K3D is active.

agoose77 commented 2 years ago

No problem! I find K3D really useful, so it's only fair to contribute back :) Thanks @renefritze for checking the PR already.

renefritze commented 2 years ago

I tried to use your PR branch locally @agoose77 :

pip install -U git+https://github.com/agoose77/K3D-jupyter.git@chore-use-hatch

and I got errors

That seems to be a problem with node dependencies? Any idea why that's happening while the CI build here seems fine?

node --version
v16.17.1

renefritze commented 2 years ago

I can replicate this in a github actions environment too: https://github.com/pymor/K3D-jupyter/actions/runs/3188630325/jobs/5201513013#step:6:99 Running from this branch

agoose77 commented 2 years ago

Thanks @renefritze - it seems like there's something not quite right with the fflate dependency loading. I thought I'd already tackled this. Let me see...

agoose77 commented 2 years ago

I think this is also happening in main - something to do with the ?raw suffix in the require() calls. I've not seen that syntax used before.

renefritze commented 2 years ago

I can confirm, basing my branch on main results in the same error in actions

agoose77 commented 1 year ago

@artur-trzesiok I don't have any more time to work on this right now. If you get a minute, would you be able to look into the fflate errors?

renefritze commented 1 year ago

@artur-trzesiok I don't have any more time to work on this right now. If you get a minute, would you be able to look into the fflate errors?

Basically the same error happens if I drop the "?raw": https://github.com/pymor/K3D-jupyter/actions/runs/3378647561/jobs/5609129890#step:6:100

Any more input @artur-trzesiok ?

agoose77 commented 1 year ago

Closed in favour of #386