catalyst-cooperative / cheshire Goto Github PK

Make sure that we're importing the dummy modules appropriately in the top level __init__.py so that they're available when the top level package is imported. This is always confusing and easy to forget.

Currently logging that takes place during Tox / pytest run isn't showing up at the console. Need to figure out how to configure that. I remember this being annoying at some point in the past when setting up new CI too. Easy to forget...

Running different Tox environments as separate jobs within GitHub Actions makes tests faster since they run in parallel on separate runners, and also provides more granular information about what's passing and what's failing. @jdangerx has implemented this improvement in the main PUDL repo, and we'd like to do it in other repositories too!

See this PR as an example.

• Add docformatter to the template repo pre-commit hooks and configuration files, copying from this PR
• Remove flake8-colors and use newly built in flake8 colored text functionality.

• Tag a release of the python-template package in git
• To a test release of the package to the PyPI test server
• Release to real PyPI server

We can speed up our CI runs a bit (which makes more of a difference on the once where it's fast) by provisioning with micromamba, as is now set up on the dev branch of PUDL.

Adapt that setup here and propagate to our other repos as appropriate.

Absolufy imports doesn't play well with VS Code's automatic import removal and the typical way that imports are used to structure public module interfaces.

The README is just a bunch of lists right now. Flesh it out with more specific instructions on how to go about setting up a new repository using the template. And offer some explanation as to what the different parts of the template are doing so they aren't cut-and-paste mysteries.

We've got good CI on a few repos, but they're all kind of different. Create a single one with all the good stuff in one place, so we can make setup easy.

• #6
• #4
• #5
• #7
• #13
• #10
• #15

• Add a cli.py module with the skeleton of a CLI.
• Add an integration test module that tests all deployed entrypoints automatically running them with --help to make sure they at least kind of work.

Bring in a basic condaforge/mambaforge based Dockerfile and set up a GitHub Action that builds it.

If we were starting from scratch today, we'd probably want to try and use type checking everywhere.

Investigate what a sane mypy setup to start out with would be, and potentially integrate that configuration and tests into the template.

The Contributor Covenant Code of Conduct has been updated to v2.1. Our existing CoC is based on v1.4. Should we update?

Also, fix the Markdown / RST conflict in the CODE_OF_CONDUCT / code_of_conduct inclusion

Connect the template repository to Read The Docs and ensure that the (minimal) documentation builds there correctly.

We've switched to a more modern, standards-compliant way of specifying our package build system and metadata in the main PUDL repository, and we should standardize on that in our template repo too.

See catalyst-cooperative/pudl#2479 for an example of the changes.

Mostly this is just cut-and-pasting information from setup.py into pyproject.toml