Merge branch 'main' of https://github.com/pythoninthegrass/python_template

Author: pythoninthegrass

.env.example

@@ -1,10 +1,15 @@
-REGISTRY_URL=1234.dkr.ecr.us-east-1.amazonaws.com
+#REGISTRY_URL=1234.dkr.ecr.us-east-1.amazonaws.com
+REGISTRY_URL=https://index.docker.io/v1/
 APP_NAME=appname
-TAG=latest
-EMAIL=thisismysingingvoice@acme.co
-URL=https://acme.co
+IMAGE=centos
+TAG=7.8.2003
 USER=apiuser
 PASSWORD=apiuserpassword
-VERBOSE=false
+EMAIL=thisismysingingvoice@acme.co
+HOST=localhost
 OVERWRITE=true
+PORT=1812
 PORT=80
+PORT2=18120
+URL=https://acme.co
+VERBOSE=false

jupyter/requirements.txt

@@ -8,10 +8,10 @@ decorator==5.1.1 ; python_full_version == "3.10.7"
 entrypoints==0.4 ; python_full_version == "3.10.7"
 executing==1.1.1 ; python_full_version == "3.10.7"
 ipykernel==6.16.0 ; python_full_version == "3.10.7"
-ipython==8.5.0 ; python_full_version == "3.10.7"
+ipython==8.10.0 ; python_full_version == "3.10.7"
 jedi==0.18.1 ; python_full_version == "3.10.7"
 jupyter-client==7.4.4 ; python_full_version == "3.10.7"
-jupyter-core==4.11.1 ; python_full_version == "3.10.7"
+jupyter-core==4.11.2 ; python_full_version == "3.10.7"
 matplotlib-inline==0.1.6 ; python_full_version == "3.10.7"
 nest-asyncio==1.5.6 ; python_full_version == "3.10.7"
 numpy==1.23.4 ; python_full_version == "3.10.7"

justfile

@@ -4,13 +4,16 @@
 set dotenv-load
 
 # set env var
-export APP      := "compose_image_name"
+export APP      := `echo ${APP_NAME}`
 export CPU      := "2"
-export IMAGE    := `echo ${REGISTRY_URL}/it
+export IMAGE	:= `echo ${IMAGE}`
 export MEM      := "2048"
 export NS       := "default"
 export PROF     := "minikube"
 export SHELL    := "/bin/bash"
+export SCRIPT   := "harden"
+export SHELL	:= "/bin/bash"
+export TAG		:= `echo ${TAG}`
 VERSION 		:= `cat VERSION`
 
 # x86_64/arm64
@@ -23,6 +26,7 @@ host := `uname -n`
 default:
     just --list
 
+# TODO: setup tilt
 # [devspace] start minikube + devspace
 start-devspace:
     #!/usr/bin/env bash
@@ -39,76 +43,110 @@ start-devspace:
 stop-devspace:
     minikube stop -p {{PROF}}
 
-# [docker] build locally
-build:
-	#!/usr/bin/env bash
-	# set -euxo pipefail
+# 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"
+} else {
+	"docker compose"
+}
 
-	echo "building ${APP_NAME}:${TAG}"
+# [halp]   list available commands
+default:
+	just --list
 
-	if [[ {{arch}} == "arm64" ]]; then
-		docker build -f Dockerfile -t it/${APP_NAME}:${TAG} --build-arg CHIPSET_ARCH=aarch64-linux-gnu .
+# [check]  lint sh script
+checkbash:
+	#!/usr/bin/env bash
+	checkbashisms {{SCRIPT}}
+	if [[ $? -eq 1 ]]; then
+		echo "bashisms found. Exiting..."
+		exit 1
 	else
-		docker build -f Dockerfile -t it/${APP_NAME}:${TAG} --build-arg CHIPSET_ARCH=x86_64-linux-gnu .
+		echo "No bashisms found"
 	fi
 
-	echo "created tag it/${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}"
-
-# TODO: QA
-# [docker] intel build
-buildx:
-	docker buildx build -f Dockerfile --progress=plain -t ${TAG} --build-arg CHIPSET_ARCH=x86_64-linux-gnu --load .
-
-# [docker] build w/docker-compose defaults
-build-nc:
+# [docker] build locally or on intel box
+build: checkbash
 	#!/usr/bin/env bash
-	# set -euxo pipefail
+	set -euxo pipefail
+	if [[ {{arch}} == "arm64" ]]; then
+		docker build -f Dockerfile -t {{APP}} --build-arg CHIPSET_ARCH=aarch64-linux-gnu .
+	else
+		docker build -f Dockerfile --progress=plain -t {{APP}} .
+	fi
 
+# [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
+		{{docker-compose}} build --pull --no-cache --build-arg CHIPSET_ARCH=aarch64-linux-gnu --parallel
 	else
-		docker-compose build --pull --no-cache --build-arg CHIPSET_ARCH=x86_64-linux-gnu
+		{{docker-compose}} build --pull --no-cache --parallel
 	fi
 
-# [docker] pull latest image
-pull:
-	docker pull {{IMAGE}}/${APP_NAME}:${TAG}
+# [docker] login to registry (exit code 127 == 0)
+login:
+	#!/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...'
+		exit 1
+	fi
+
+# [docker] tag image as latest
+tag-latest:
+	docker tag {{APP}}:latest {{IMAGE}}/{{APP}}:latest
 
-# [docker] run local image
-run: pull
-	docker run -it --rm -v $(pwd):/app {{IMAGE}}/${APP_NAME}:${TAG} {{SHELL}}
+# [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] push latest image to ecr
-release:
+# [docker] run container
+run: build
 	#!/usr/bin/env bash
 	# set -euxo pipefail
-
-	AWS_DEFAULT_PROFILE=bastion.use1 aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin ${REGISTRY_URL}
-	docker push {{IMAGE}}/${APP_NAME}:${TAG}
+	docker run --rm -it \
+		--name {{APP}} \
+		--env-file .env \
+		--entrypoint={{SHELL}} \
+		-h ${HOST:-localhost} \
+		-v $(pwd)/conf:/etc/duoauthproxy \
+		-p ${PORT:-1812}:${PORT:-1812/udp} \
+		-p ${PORT2:-18120}:${PORT2:-18120/udp} \
+		--cap-drop=all \
+		--cap-add=setgid \
+		--cap-add=setuid \
+		{{APP}}
 
 # [docker] start docker-compose container
-start:
-    docker-compose up -d
+up: build
+	{{docker-compose}} up -d
+
+# [docker] get running container logs
+logs:
+	{{docker-compose}} logs -tf --tail="50" {{APP}}
 
 # [docker] ssh into container
 exec:
-    docker-compose exec {{APP}} {{SHELL}}
+	docker exec -it {{APP}} {{SHELL}}
 
 # [docker] stop docker-compose container
 stop:
-    docker-compose stop
+	{{docker-compose}} stop
 
 # [docker] remove docker-compose container(s) and networks
 down: stop
-	docker-compose down --remove-orphans
-
-# [docker] tag image as latest
-tag-latest:
-	@echo "create tag it/${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}"
-	docker tag it/${APP_NAME}:${TAG} {{IMAGE}}/${APP_NAME}:${TAG}
-
-# TODO: QA
-# [docker] tag image from VERSION file
-tag-version:
-	@echo "create tag it/${APP_NAME}:{{VERSION}} {{IMAGE}}/${APP_NAME}:${TAG}"
-	docker tag it/${APP_NAME}:{{VERSION}} {{IMAGE}}/${APP_NAME}:${TAG}
+	{{docker-compose}} down --remove-orphans

markdown/just.md

@@ -0,0 +1,30 @@
+# justfile
+
+> [just](https://just.systems/man/en/chapter_1.html) is a handy way to save and run project-specific commands.
+> 
+> Commands, called recipes, are stored in a file called justfile with syntax inspired by make:
+
+## [Install](https://just.systems/man/en/chapter_4.html)
+```bash
+# macOS
+brew install just
+
+# Ubuntu/Debian
+curl -q 'https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub' | gpg --dearmor | sudo tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null
+echo "deb [arch=amd64 signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $(lsb_release -cs)" | sudo tee /etc/apt/sources.list.d/prebuilt-mpr.list
+sudo apt update
+sudo apt install just -y
+```
+
+## Usage
+```bash
+# default commands
+just
+
+# custom directives
+just buildx         # [docker] intel build
+just pull           # [docker] pull latest image
+just run            # [docker] run local image
+just up             # [docker] start docker-compose container
+just down           # [docker] remove docker-compose container(s) and networks
+```