admin/update-to-new-cookiecutter

[evamaxfield]

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 and isort automatically plus type-checking.

Those four things were the largest culprits of failure.

• Py310 isn't supported in this library because of upstream cellpack dependency which depends on panda3d.
• black and isort 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 files
• mypy / 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 for just install you will see it does a VERY long install string. Technically this is "safer" than the pip 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 replaces tox. just lint / pre-commit replaces tox just build replaces tox

Let me know if you have questions

[evamaxfield]

Build passing :tada:

[blairlyons]

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

[evamaxfield]

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:

1. There are now merge conflicts
2. Because I am a new contributor to this repo, after the merge conflicts are fixed, you have to manually click like "Run Actions" or something. It will pop up at the bottom of the PR page after merge conflicts are gone.

A bit busy today. I can fix merge conflicts tomorrow or you can push to my branch