python_template/justfile at dev · SourceryAI/python_template

255 lines (217 loc) · 7.1 KB
# See https://just.systems/man/en
# positional args
# * NOTE: unable to reuse recipe name (e.g., start/stop); prefix recipes with `@`
# set positional-arguments := true
# load .env
set dotenv-load
# set env var
export APP      := `echo ${APP_NAME}`
export CPU      := `echo ${CPU}`
export IMAGE    := `echo ${IMAGE}`
export MEM      := `echo ${MEM}`
export NS       := `echo ${NS}`
export PROF     := `echo ${PROF}`
export SCRIPT   := "harden"
export SHELL    := `echo ${SHELL}`
export TAG      := `echo ${TAG}`
export VERSION  := "latest"
# x86_64/arm64
arch := `uname -m`
host := `uname -n`
# operating system
os := `uname -s`
# home directory
home_dir := env_var('HOME')
# docker-compose / docker compose
# * https://docs.docker.com/compose/install/linux/#install-using-the-repository
docker-compose := if `command -v docker-compose; echo $?` == "0" {
	"docker-compose"
	"docker compose"
# [halp]     list available commands
	just --list
# [init]     install dependencies, tooling, and virtual environment
    #!/usr/bin/env bash
    set -euxo pipefail
    # TODO: QA
    # dependencies
    if [[ {{os}} == "Linux" ]]; then
        . "/etc/os-release"
        case $ID in
            ubuntu|debian)
                sudo apt update && sudo apt install -y \
                    build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl \
                    llvm libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
            arch|endeavouros)
                sudo pacman -S --noconfirm \
                    base-devel openssl zlib bzip2 xz readline sqlite tk
            fedora)
                sudo dnf install -y \
                    make gcc zlib-devel bzip2 bzip2-devel readline-devel \
                    sqlite sqlite-devel openssl-devel xz xz-devel libffi-devel
            centos)
                sudo yum install -y \
                    make gcc zlib-devel bzip2 bzip2-devel readline-devel \
                    sqlite sqlite-devel openssl-devel xz xz-devel libffi-devel
                echo "Unsupported OS"
        esac
    elif [[ {{os}} == "Darwin" ]]; then
        xcode-select --install
        [[ $(command -v brew >/dev/null 2>&1; echo $?) == "0" ]] || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
        brew install gettext openssl readline sqlite3 xz zlib tcl-tk
    elif [[ os() == "Windows"]]; then
        echo "Windows is not supported"
        exit 1
        echo "Unsupported OS"
        exit 1
    # install asdf
    git clone https://github.com/asdf-vm/asdf.git "{{home_dir}}/.asdf" --branch v0.11.1
    . "{{home_dir}}/.asdf/asdf.sh"
    # install python w/asdf
    asdf plugin-add python
    asdf install python {{PY_VER}}
    # install poetry
    asdf plugin-add poetry https://github.com/asdf-community/asdf-poetry.git
    asdf install poetry {{POETRY}}
    # create virtual environment
    poetry config virtualenvs.in-project true
    poetry env use python
    poetry install --no-root
# [deps]     update dependencies
update-deps:
    #!/usr/bin/env bash
    # set -euxo pipefail
    find . -maxdepth 3 -name "pyproject.toml" -exec \
        echo "[{}]" \; -exec \
        echo "Clearing pypi cache..." \; -exec \
        poetry cache clear --all pypi --no-ansi \; -exec \
        poetry update --lock --no-ansi \;
# [deps]     export requirements.txt
export-reqs: update-deps
    #!/usr/bin/env bash
    # set -euxo pipefail
    find . -maxdepth 3 -name "pyproject.toml" -exec \
        echo "[{}]" \; -exec \
        echo "Exporting requirements.txt..." \; -exec \
        poetry export --no-ansi --without-hashes --output requirements.txt \;
# [git]      update git submodules
    @echo "To add a submodule:"
    @echo "git submodule add https://github.com/username/repo.git path/to/submodule"
    @echo "Updating all submodules..."
    git submodule update --init --recursive && git pull --recurse-submodules -j8
# [git]      update pre-commit hooks
pre-commit:
    @echo "To install pre-commit hooks:"
    @echo "pre-commit install -f"
    @echo "Updating pre-commit hooks..."
    pre-commit autoupdate
# [minikube] start minikube + tilt
start-minikube:
    #!/usr/bin/env bash
    set -euxo pipefail
    if [[ $(minikube status -f \{\{\.Host\}\}) = 'Stopped' ]]; then
        minikube start --memory={{MEM}} --cpus={{CPU}} -p {{PROF}}
# [tilt]     deploy docker image to local k8s cluster
tilt-up: start-minikube
    tilt up
# [minikube] stop minikube
stop-minikube:
    minikube stop -p {{PROF}}
# [check]    lint sh script
	#!/usr/bin/env bash
	checkbashisms {{SCRIPT}}
	if [[ $? -eq 1 ]]; then
		echo "bashisms found. Exiting..."
		echo "No bashisms found"
# [docker]   build locally
build: checkbash
	#!/usr/bin/env bash
	set -euxo pipefail
	if [[ {{arch}} == "arm64" ]]; then
		docker build -f Dockerfile -t {{APP}} --build-arg CHIPSET_ARCH=aarch64-linux-gnu .
		docker build -f Dockerfile --progress=plain -t {{APP}} .
# [scripts]  run script in working directory
sh args=SCRIPT:
    sh {{args}}
# [docker]   intel build
buildx: checkbash
	docker buildx build -f Dockerfile --progress=plain -t ${TAG} --build-arg CHIPSET_ARCH=x86_64-linux-gnu --load .
# [docker]   arm build w/docker-compose defaults
build-clean: checkbash
	#!/usr/bin/env bash
	set -euxo pipefail
	if [[ {{arch}} == "arm64" ]]; then
		{{docker-compose}} build --pull --no-cache --build-arg CHIPSET_ARCH=aarch64-linux-gnu --parallel
		{{docker-compose}} build --pull --no-cache --parallel
# [docker]   login to registry (exit code 127 == 0)
	#!/usr/bin/env bash
	# set -euxo pipefail
	echo "Log into ${REGISTRY_URL} as ${USER_NAME}. Please enter your password: "
	cmd=$(docker login --username ${USER_NAME} ${REGISTRY_URL})
	if [[ $("$cmd" >/dev/null 2>&1; echo $?) -ne 127 ]]; then
		echo 'Not logged into Docker. Exiting...'
# [docker]   tag image as latest
tag-latest:
	docker tag {{APP}}:latest {{IMAGE}}/{{APP}}:latest
# [docker]   tag latest image from VERSION file
tag-version:
	@echo "create tag {{APP}}:{{VERSION}} {{IMAGE}}/{{APP}}:{{VERSION}}"
	docker tag {{APP}} {{IMAGE}}/{{APP}}:{{VERSION}}
# [docker]   push latest image
push: login
	docker push {{IMAGE}}/{{APP}}:{{TAG}}
# [docker]   pull latest image
pull: login
	docker pull {{IMAGE}}/{{APP}}
# [docker]   run container
	#!/usr/bin/env bash
	# set -euxo pipefail
	docker run --rm -it \
		--name {{APP}} \
		--env-file .env \
		--entrypoint={{SHELL}} \
		-h ${HOST:-localhost} \
		-v $(pwd)/app:/app \
# [docker]   start docker-compose container
	{{docker-compose}} up -d
# [docker]   get running container logs
	{{docker-compose}} logs -tf --tail="50" {{APP}}
# [docker]   ssh into container
	docker exec -it {{APP}} {{SHELL}}
# [docker]   stop docker-compose container
	{{docker-compose}} stop
# [docker]   remove docker-compose container(s) and networks
	{{docker-compose}} down --remove-orphans
FilesExpand file tree

justfile

Latest commit

History

justfile

File metadata and controls
