justfile

# just has no idiom for setting a default value for an environment variable
# so we shell out, as we need VIRTUAL_ENV in the justfile environment
exportVIRTUAL_ENV:=`echo ${VIRTUAL_ENV:-.venv}`

# TODO: make it /scripts on windows?
exportBIN:= VIRTUAL_ENV +"/bin"
exportPATH:=env_var('PATH') +":"+justfile_directory() +"/"+ BIN
exportPIP:= BIN +"/python -m pip"
# enforce our chosen pip compile flags
exportCOMPILE:= BIN +"/pip-compile --allow-unsafe --generate-hashes"


# list available commands
default:
@{{just_executable() }} --list


# clean up temporary files
clean:
 rm -rf .venv


# ensure valid virtualenv
virtualenv:
 #!/usr/bin/env bash
 set -euo pipefail

# allow users to specify python version in .env
 PYTHON_VERSION=${PYTHON_VERSION:-python3.11}

# create venv and upgrade pip
 test -d $VIRTUAL_ENV || { $PYTHON_VERSION -m venv $VIRTUAL_ENV && $PIP install --upgrade pip; }

# ensure we have pip-tools so we can run pip-compile
 test -e $BIN/pip-compile || $PIP install pip-tools


_compilesrcdst*args:virtualenv
 #!/usr/bin/env bash
 set -euo pipefail

# exit if src file is older than dst file (-nt = 'newer than', but we negate with || to avoid error exit code)
 test "${FORCE:-}" = "true" -o {{ src }} -nt {{ dst }} || exit 0
 $BIN/pip-compile --allow-unsafe --generate-hashes --output-file={{ dst }}{{ src }}{{ args }}


# update requirements.prod.txt if requirements.prod.in has changed
requirements-prod*args:
{{just_executable() }} _compile requirements.prod.in requirements.prod.txt {{ args }}


# update requirements.dev.txt if requirements.dev.in has changed
requirements-dev*args:requirements-prod
{{just_executable() }} _compile requirements.dev.in requirements.dev.txt {{ args }}


# ensure prod requirements installed and up to date
prodenv:requirements-prodfetch-cohort-extractor
 #!/usr/bin/env bash
 set -euo pipefail

# exit if .txt file has not changed since we installed them (-nt == "newer than', but we negate with || to avoid error exit code)
 test requirements.prod.txt -nt $VIRTUAL_ENV/.prod || exit 0

 $PIP install -r requirements.prod.txt
 touch $VIRTUAL_ENV/.prod


# && dependencies are run after the recipe has run. Needs just>=0.9.9. This is
# a killer feature over Makefiles.
#
# ensure dev requirements installed and up to date
devenv:prodenvrequirements-dev&&install-precommit
 #!/usr/bin/env bash
 set -euo pipefail

# exit if .txt file has not changed since we installed them (-nt == "newer than', but we negate with || to avoid error exit code)
 test requirements.dev.txt -nt $VIRTUAL_ENV/.dev || exit 0

 $PIP install -r requirements.dev.txt
 touch $VIRTUAL_ENV/.dev


# ensure precommit is installed
install-precommit:
 #!/usr/bin/env bash
 set -euo pipefail

 BASE_DIR=$(git rev-parse --show-toplevel)
 test -f $BASE_DIR/.git/hooks/pre-commit || $BIN/pre-commit install


# upgrade dev or prod dependencies (specify package to upgrade single package, all by default)
upgradeenvpackage="":virtualenv
 #!/usr/bin/env bash
 set -euo pipefail

 opts="--upgrade"
 test -z "{{ package }}" || opts="--upgrade-package {{ package }}"
 FORCE=true{{just_executable() }} requirements-{{env}} $opts

# Fetch cohort-extractor submodule
fetch-cohort-extractor:
 git submodule update --init

# Update cohort-extractor submodule
update-cohort-extractor:
 git submodule update --remote src/cohort-extractor

# Requires Vale: https://github.com/errata-ai/vale
lint-docs:
 vale ./docs

# Run the tests
test:devenv
 echo "Not implemented here"


format*args=".":devenv
 $BIN/ruff format --check {{ args }}

lint*args=".":devenv
 $BIN/ruff check {{ args }}

# run the various dev checks but does not change any files
check:formatlint


# fix formatting and import sort ordering
fix:devenv
 $BIN/ruff check --fix .
 $BIN/ruff format .

# Run the dev project
run:devenv
 $BIN/mkdocs serve -a localhost:8910

# Build the documentation
build:devenv
 $BIN/mkdocs build

# Count words in generated documentation content (within <article> tags)
wordcount:build
 #!/usr/bin/env bash
 set -euo pipefail
 find site/ -name '*.html' -exec python scripts/wordcount.py {} + | awk '{sum += $1} END {print "Total words in documentation:", sum}'