Cookiecut - Python 3.11, 3.12, 3.13 priority tasks and communication channel

[bobleesj]

(To be closed after we are done with cookiecuting)

• always make a PR into the cookie branch

[bobleesj]

Priority

1. pre-commit setup

• Fix flake8 errors - line too long #1184
• Address codespell spelling suggestions #1185

2. pip install -e . && pytest runs

• Add pip.txt in pyproject.toml #1177
• Fix 4 pytest failed error in src/regolith/tests/test_builders.py #1186

3. Proper GitHub CI setup

• Double check GitHub CI .yml files - there are more than enough of as now #1180
• Add Codecov Report in PR (new cookiecutting standard) #1173
• make github workflow for building docs on merge to main #1068
• Implement pre-commit at the PR level - remove a separate CI for running pre-commit #1181 by @sbillinge

4. Python 3.11 support

• Wondering purpose of github_deploy_key.enc #1179
• Fix 4 pytest failed error in src/regolith/tests/test_builders.py #1186
• Relocate tests folder to top project level #1178
• package metadata not found #1161
• reset tests in .github/workflows to run on pr to main instead of cookie #1196 - after cookie merged to main
• Fix pytest 40 warnings from matplotlib plot_date #1201
• news for the cookiecutting activity #1214
• Existence of two GitHub pages - deploy API docs #1218

---

5. Python 3.12 support

• Pytest sometimes passes, sometimes does not in Python 3.12 env #1204
• disutils package has become deprecated #927

6. Python 3.13 support

• Pytest fail due to no module named 'distutils' in Python 3.13 env #1202

7. Pytest, docs, tutorials, warnings

• project description.... #1067
• add a longer description to README.rst #1170
• Fix pytest warnings: exemplars not matching schemas #1208
• Fix pytest warnings: Data Validation extension / Unknown extension #1209
• Fix pytest 34 skipped  #1200

9. Conda-forge

• fix feedstock meta.yaml and setup.py #1053

Goal: make a good looking package satisfying our Release checklist

@tinatn29 since I've created lots of issues, I wanted to organize them a bit - we can use this issue here to communicate any tasks that are of interest to all maintainers/reviewers.

[bobleesj]

(A quick note to maintainers) recut this package before we are about to make a release checklist

[tinatn29]

created #1200 and #1201 to fix pytest skipped and warnings

[bobleesj]

@tinatn29 Since we have Python 3.11 CI configured here #1203, we could address all of the issues under Python 3.11 support (remove warnings/skipped tests) above and then update our CI to 3.12, then 3.13, resolving issues systematically..

[sbillinge]

@bobleesj @tinatn29 is most of the cookiecutting done, and now it is remediating all the technical debt? If so, I am inclined to merge cookie into main as all the tests are currently passing on CI. If all the large moving around of files is done and CI is running we can do future updates into main. OK to merge cookie into main?

[bobleesj]

@sbillinge We still need to move test files outside of src. This, I will look into it. Then, we can probably merge cookie to main.

[bobleesj]

@sbillinge I double checked - tests is moved out of src already. Thanks to @tinatn29

Yes, looks good to merge to main.

[bobleesj]

One last thing - @sbillinge could you setup pre-commit at the repository level? It should all pass.

Ref: #1181

[sbillinge]

haha, getting to green...

pre-commit working on the repo....codecov working on the repo (everything red before). The tests on pr (push) would turn red if I raran it as it runs the same thing as tests on pr (pull request). I guess there is no news, but I think there may be a news that was merged direclty to main before we went to the cookie branch. I will merge like this since tests are passing and then check.

[bobleesj]

@sbillinge @tinatn29 yes, great and steady progress.. it will be SO much easier to build on this repo moving forward!

[tinatn29]

@sbillinge @bobleesj How do I fix skipped tests #1200? Do I need to do this before proceeding with the API documentation step (is there an issue for this already?) and adding news #1214?

[sbillinge]

leave the skips for now. Many of them are only skipped on some platforms. I think they are not a tip priority. We can return to them later.