WayScience / coSMicQC

Single cell Morphology Quality Control (coSMicQC)
BSD 3-Clause "New" or "Revised" License
2 stars 2 forks source link

Fix for environment setup with PyPI package build action #26

Closed d33bs closed 1 month ago

d33bs commented 1 month ago

Description

This fixes a bug with the environment setup for PyPI package builds through GitHub actions exhibited here. This was a fault on my part in attempting to reuse code across projects (apologies!).

Thanks for any thoughts from review here!

What kind of change(s) are included?

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

d33bs commented 1 month ago

Thanks @jenna-tomkinson !

For my own understanding, what was the issue/bug?

We rely on poetry build to help collect the Python package materials for distribution on PyPI (which requires special organization of the files for installation from that platform). The GitHub Actions workflow associated with this is a container which doesn't know about Python, Poetry, or our package state by default. Thus, in order to use poetry build we need to install Python, Poetry, and our package dependencies (from poetry install) in order for the container to know how to build the package for PyPI. The earlier code which was intended to perform this is a reused block from another project which I recycled but wasn't thorough enough about checking before submitting a PR (bad form on my part, sorry!). We don't yet have the related capabilities from that block of code (and I'm not certain they're necessary yet here). So to fix the bug, I removed this unnecessary / non-existent capability, and added the related installation steps which are needed. These align with other Python and Poetry installation steps which are found for example in https://github.com/WayScience/coSMicQC/blob/main/.github/workflows/run-tests.yml .