Merge pull request #5 from IMIO/uv

Update Makefile with uv tools and .gitignore

Author: thomlamb

.gitignore

@@ -28,3 +28,5 @@ pyvenv.cfg
 eggs/
 .vscode
 .lock
+.DS_Store
+resources/

.pre-commit-config.yaml

@@ -1,75 +1,36 @@
+---
+default_stages:
+  - pre-commit
+  - pre-push
 repos:
--   repo: https://github.com/chriskuehl/puppet-pre-commit-hooks.git
-    rev: v2.0.1
+  - repo: "https://github.com/pre-commit/pre-commit-hooks"
+    rev: v5.0.0
     hooks:
-    -   id: puppet-validate
-        stages: [commit, push]
-    -   id: erb-validate
-        stages: [commit, push]
-    -   id: epp-validate
-        stages: [commit, push]
-    -   id: puppet-lint
-        stages: [commit, push]
--   repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v1.2.3
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+  - repo: "https://github.com/asottile/yesqa"
+    rev: v1.5.0
     hooks:
-    -   id: trailing-whitespace
-        stages: [commit, push]
-    -   id: check-json
-        stages: [commit, push]
-    -   id: flake8
-        stages: [commit, push]
-    -   id: check-yaml
-        stages: [commit, push]
-    -   id: check-xml
-        stages: [commit, push]
-    -   id: check-merge-conflict
-        stages: [commit, push]
-    -   id: debug-statements
-        stages: [commit, push]
-    -   id: fix-encoding-pragma
-        stages: [commit, push]
-    -   id: check-symlinks
-        stages: [commit, push]
-    -   id: debug-statements
-        stages: [commit, push]
--   repo: https://github.com/jumanjihouse/pre-commit-hooks.git
-    rev: 1.6.0
+      - id: yesqa
+  - repo: "https://github.com/adrienverge/yamllint"
+    rev: v1.37.1
     hooks:
-    -   id: shellcheck
-        stages: [commit, push]
-    -   id: shfmt
-        stages: [commit, push]
--   repo: https://github.com/pre-commit/mirrors-csslint.git
-    rev: 845a4fd9e41e6227b237ddd6054c33b5a08f9fb0
+      - id: yamllint
+        args: ["-d", "relaxed"]
+  - repo: "https://github.com/jorisroovers/gitlint.git"
+    rev: v0.19.1
     hooks:
-    -   id: csslint
-        stages: [commit, push]
--   repo: https://github.com/asottile/yesqa
-    rev: f657d64b0ca01f7f44ee0006c2990af988139c28
+      - id: gitlint
+        stages:
+          - commit-msg
+  - repo: local
     hooks:
-    -   id: yesqa
-        stages: [commit, push]
--   repo: https://github.com/adrienverge/yamllint
-    rev: 506e066410052c42da36c237b8ba3c661448c86b
-    hooks:
-    -   id: yamllint
-        stages: [commit, push]
-#-   repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
-#    rev: 8535cb046711121d3591fa31843e2be3f3a26813
-#    hooks:
-#    -   id: dockerfile_lint
-#        stages: [commit, push]
--   repo: https://github.com/jorisroovers/gitlint.git
-    rev: e4e627dd5b5f1dbc1168782ea6fd9874242fa41a
-    hooks:
-    -   id: gitlint
-        stages: [commit-msg]
-
-#-   repo: local
-#    hooks:
-#    -   id: run-tests
-#        name: Running local test
-#        entry: make test
-#        language: system
-#        stages: [commit, push]
+      - id: check-dockerfile
+        name: "Check dockerfile"
+        entry: 'bash -c "docker run --rm -i hadolint/hadolint < Dockerfile"'
+        pass_filenames: false
+        language: system
+        types:
+          - dockerfile

.python-version

@@ -0,0 +1 @@
+3.12

Makefile

@@ -1,54 +1,48 @@
-#!/usr/bin/make
-all: buildout
+VENV_FOLDER=.venv
 
-IMAGE_NAME="harbor.imio.be/web/library/mutual:latest"
-MID=couvin
+ifeq (, $(shell which uv ))
+  $(error "[ERROR] The 'uv' command is missing from your PATH. Install it from: https://docs.astral.sh/uv/getting-started/installation/")
+endif
 
-buildout.cfg:
-	ln -fs dev.cfg buildout.cfg
-
-bin/buildout: bin/pip buildout.cfg
-	bin/uv pip install -r requirements.txt
-
-buildout: bin/instance
+.PHONY: help
+help: ## Display this help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-bin/instance: bin/buildout
-	bin/buildout
+.PHONY: install
+install: $(VENV_FOLDER)/bin/buildout .git/hooks/pre-commit ## Install development environment
+	$(VENV_FOLDER)/bin/buildout
 
-bin/pip:
-	python3.10 -m venv .
-	bin/pip install uv
-
-run: bin/instance
+.PHONY: start
+start: bin/instance .git/hooks/pre-commit ## Start the instance
 	bin/instance fg
 
-docker-image:
-	docker build --pull -t library/mutual:latest .
-
-eggs:  ## Copy eggs from docker image to speed up docker build
-	-docker run --entrypoint='' $(IMAGE_NAME) tar -c -C /plone eggs | tar x
-	mkdir -p eggs
+.PHONY: cleanall
+cleanall: ## Clean development environment
+	rm -fr .git/hooks/pre-commit .installed.cfg .mr.developer.cfg .venv bin buildout.cfg develop-eggs downloads eggs include lib lib64 local parts pyvenv.cfg
 
-cleanall:
-	rm -fr develop-eggs downloads eggs parts .installed.cfg lib lib64 include bin .mr.developer.cfg local/
+.PHONY: upgrade-steps
+upgrade-steps: ## Run upgrade steps
+	bin/instance -O Plone run scripts/run_portal_upgrades.py
 
-rsync:
-	rsync -P imio@bibliotheca.imio.be:/srv/instances/$(MID)/filestorage/Data.fs var/filestorage/Data.fs
-	rsync -r --info=progress2 imio@bibliotheca.imio.be:/srv/instances/$(MID)/blobstorage/ var/blobstorage/
+.PHONY: lint
+lint: ## Run pre-commit hooks
+	uvx pre-commit run --all
 
-bash:
-	docker-compose run --rm -p 8080:8080 -u imio instance bash
+.venv:
+	@echo "Creating virtual environment with uv"
+	uv venv
 
-chown-docker-dev:
-	sudo chown 913:209 -R var
+buildout.cfg:
+	ln -fs dev.cfg buildout.cfg
 
-chown-local-dev:
-	sudo chown $(USER):$(USER) -R src/plone.app.contenttypes
-	sudo chown $(USER):$(USER) -R src/plone.outputfilters
-	sudo chown $(USER):$(USER) -R var
+$(VENV_FOLDER)/bin/buildout: .venv buildout.cfg
+	@echo "Installing requirements with uv pip interface"
+	uv pip install -r requirements.txt
 
-upgrade-steps:
-	bin/instance -O plone run scripts/run_portal_upgrades.py
+bin/instance: $(VENV_FOLDER)/bin/buildout
+	@echo "Bootstrapping environment with buildout"
+	$(VENV_FOLDER)/bin/buildout
 
-test-image:
-	echo "todo"
+.git/hooks/pre-commit: .venv
+	@echo "Installing pre-commit hooks"
+	uvx pre-commit install