Usage

To create a new repository using this template:

1. Create a basic devcontainer either using the Codespaces default or using the file .devcontainer/devcontainer-to-instantiate-template.json from the base template repo
2. Inside that devcontainer, run python .devcontainer/install-ci-tooling.py to install necessary tooling to instantiate the template (you can copy/paste the script from this repo...and you can paste it in the root of the repo if you want)
3. Delete all files currently in the repository. Optional...but makes it easiest to avoid git conflicts.
4. Run copier to instantiate the template: copier copy --trust gh:LabAutomationAndScreening/copier-python-package-template.git .
5. Run SKIP_PLAYWRIGHT_INSTALL=1 python .devcontainer/manual-setup-deps.py --only-create-lock --allow-uv-to-install-python --skip-updating-devcontainer-hash to generate the lock file(s)
6. Stage all files to prepare for commit (git add .)
7. Run python3 .github/workflows/hash_git_files.py . --for-devcontainer-config-update to update the hash for your devcontainer file
8. Commit the changes (optional)
9. Rebuild your new devcontainer

Development

Multi-step workflows are defined as Task tasks. Run task --list to see them; the definitions live in .config/taskfiles/, and Taskfile.yaml in the repo root is only a shim that includes them.

Updating from the template

This repository uses a copier template. To pull in the latest updates from the template, run task copier-update