Closed evamaxfield closed 2 years ago
Build passing :tada:
I tried just editing ci.yml to remove Python 3.7 (we don't support it anymore, checks failed), but now checks aren't running. Do we need to add something to make the workflow run when PR is edited not just opened? @evamaxfield @ascibisz
I tried just editing ci.yml to remove Python 3.7 (we don't support it anymore, checks failed), but now checks aren't running. Do we need to add something to make the workflow run when PR is edited not just opened? @evamaxfield @ascibisz
Iirc its because of two things:
A bit busy today. I can fix merge conflicts tomorrow or you can push to my branch
Problem
What is the problem this work solves, including Link to story or ticket
@blairlyons asked me to try and update to the new cookiecutter I made: https://github.com/evamaxfield/cookiecutter-py-package
Solution
What I/we did to solve this problem
I ran the upgrade and debugged everything I could.
Will debug CI as it fails (but I hope it works out-of-the-gate).
Note: docs uses a new theme.
Some comments:
The cookiecutter I maintain is meant to build packages to py310 and it has formatting with
black
andisort
automatically plus type-checking.Those four things were the largest culprits of failure.
cellpack
dependency which depends onpanda3d
.black
andisort
are good for formatting. @toloudis can back me up here :woman_shrugging: but if I had run them in this PR, the PR would have changed ~80 filesmypy
/ type checking is cool. But a lot to debug without the context of the library. Add it whenever you want if you want the extra "statically typed check" safety measure (I would argue that anything IO based should add type checking because FileIO errors are hard for users to understand :woman_shrugging:)There were some other specific changes from the cookiecutter I made to make this work. The
just install
command creates a conda env and then installs readdy and numpy from conda-forge along with installing all the deps.If you look at the
Justfile
forjust install
you will see it does a VERY long install string. Technically this is "safer" than thepip install -e .[dev]
we used to do because we have more explicit control over the installs but it is annoying, so we just have a just command for it.just test
replacestox
.just lint
/pre-commit
replacestox
just build
replacestox
Let me know if you have questions