build: 🔧 match template-website justfile

Author: martonvago

README.md

@@ -1,6 +1,11 @@
+
+
 # Template for Seedcase Python packages
 
-This repository contains a template for setting up new Python package projects in Seedcase. The first step is to create a new repository using this template. This can easily be done by clicking the "Use this template" button on the repository page or by using the GitHub CLI:
+This repository contains a template for setting up new Python package
+projects in Seedcase. The first step is to create a new repository using
+this template. This can easily be done by clicking the “Use this
+template” button on the repository page or by using the GitHub CLI:
 
 ``` bash
 # NAME is the name to give the new repository
@@ -9,11 +14,14 @@ gh repo create NAME --template seedcase-project/template-python-project
 
 ## Setting things up after cloning
 
-Search for `NAME` and `REPO` and replace them with the name of your project and the repository name. Then look for any `TODO` items.
+Search for `NAME` and `REPO` and replace them with the name of your
+project and the repository name. Then look for any `TODO` items.
 
 ## Setting things up
 
-Use the commands found in [`spaid`](https://github.com/seedcase-project/spaid) repo to run the next setup steps.
+Use the commands found in
+[`spaid`](https://github.com/seedcase-project/spaid) repo to run the
+next setup steps.
 
 Need to install these packages after:
 

README.qmd

@@ -0,0 +1,23 @@
+# Template for Seedcase Python packages
+
+This repository contains a template for setting up new Python package projects in Seedcase. The first step is to create a new repository using this template. This can easily be done by clicking the "Use this template" button on the repository page or by using the GitHub CLI:
+
+``` bash
+# NAME is the name to give the new repository
+gh repo create NAME --template seedcase-project/template-python-project
+```
+
+## Setting things up after cloning
+
+Search for `NAME` and `REPO` and replace them with the name of your project and the repository name. Then look for any `TODO` items.
+
+## Setting things up
+
+Use the commands found in [`spaid`](https://github.com/seedcase-project/spaid) repo to run the next setup steps.
+
+Need to install these packages after:
+
+``` bash
+uv add --dev pre-commit ruff typos pytest bandit commitizen \
+    genbadge jupyter pytest-cov quartodoc
+```

justfile

@@ -1,8 +1,11 @@
 @_default:
     just --list --unsorted
 
+@_checks: check-spelling check-commits
+@_builds: build-contributors build-website build-readme
+
 # Run all build-related recipes in the justfile
-run-all: check-spelling check-commits build-website
+run-all: update-quarto-theme update-template _checks test _builds
 
 # Install the pre-commit hooks
 install-precommit:
@@ -13,6 +16,18 @@ install-precommit:
   # Update versions of pre-commit hooks
   uvx pre-commit autoupdate
 
+# Update the Quarto seedcase-theme extension
+update-quarto-theme:
+  quarto add seedcase-project/seedcase-theme --no-prompt
+
+# Update files in the template from the copier parent folder
+update-template:
+  cp .cz.toml .pre-commit-config.yaml .typos.toml .editorconfig template/
+  mkdir -p template/tools
+  cp tools/get-contributors.sh template/tools/
+  cp .github/pull_request_template.md template/.github/
+  cp .github/workflows/build-website.yml .github/workflows/dependency-review.yml template/.github/workflows/
+
 # Check the commit messages on the current branch that are not on the main branch
 check-commits:
   #!/bin/zsh
@@ -29,6 +44,24 @@ check-commits:
 check-spelling:
   uvx typos
 
+# Test and check that a Python package can be created from the template
+# TODO: add test for copier
+test:
+  echo "copier test"
+
+# Clean up any leftover and temporary build files
+cleanup:
+  #!/bin/zsh
+  rm -rf _temp
+
 # Build the website using Quarto
 build-website:
   uvx --from quarto quarto render
+
+# Re-build the README file from the Quarto version
+build-readme:
+  uvx --from quarto quarto render README.qmd --to gfm
+
+# Generate a Quarto include file with the contributors
+build-contributors:
+  sh ./tools/get-contributors.sh seedcase-project/template-workshop

tools/get-contributors.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+# Get a list of contributors to this repository and save it to
+# _contributors.qmd.tmp file. It also:
+#
+# - Formats users into Markdown links to their GitHub profiles.
+# - Removes any usernames with the word "bot" in them.
+# - Removes the trailing comma from the list.
+repo_spec=${1}
+echo "These are the people who have contributed by submitting changes through pull requests :tada:\n\n" > _contributors.qmd.tmp
+gh api \
+  -H "Accept: application/vnd.github+json" \
+  -H "X-GitHub-Api-Version: 2022-11-28" \
+  /repos/$repo_spec/contributors \
+  --template '{{range .}} [\@{{.login}}]({{.html_url}}){{"\n"}}{{end}}' | \
+  grep -v "\[bot\]" | \
+  tr '\n' ', ' | \
+  sed -e 's/,$//' >> _contributors.qmd.tmp