refactor: project structure

.dockerignore

@@ -0,0 +1 @@
+.env

.example.env

@@ -0,0 +1,4 @@
+WEBAPP_PORT=8501
+API_PORT=15400
+SHAPES_PATH=/shacl/data/shapes.ttl
+SHAPES_URL='https://github.com/sdsc-ordes/imaging-plaza-ontology/releases/download/v0.8/ImagingOntologyCombined.ttl.gz'

Makefile

@@ -0,0 +1,54 @@
+VERSION = latest
+IMAGE = ghcr.io/sdsc-ordes/shacl-api
+CONTAINER_RUNTIME ?= docker
+
+.PHONY: docker-build
+docker-build: ## Build Docker images
+	@echo "🐋 Building docker image"
+
+	$(CONTAINER_RUNTIME) build \
+		-f tools/docker/Dockerfile \
+		-t $(IMAGE):$(VERSION) \
+		--build-arg VERSION=$(VERSION) \
+		--target api .
+
+	$(CONTAINER_RUNTIME) build \
+		-f tools/docker/Dockerfile \
+		-t $(IMAGE):$(VERSION)-webapp \
+		--build-arg VERSION=$(VERSION) \
+		--target webapp .
+
+.PHONY: docker-push
+docker-push: docker-build ## Push Docker images
+	@echo "🐋 Pushing docker image"
+	$(CONTAINER_RUNTIME) push $(IMAGE):$(VERSION)
+	$(CONTAINER_RUNTIME) push $(IMAGE):$(VERSION)-webapp
+
+docker-compose-up: ## Run the Docker Compose stack
+	@echo "🐋 Running docker-compose"
+	$(CONTAINER_RUNTIME) compose \
+		-f tools/docker/compose.yml \
+		up --build
+
+.PHONY: format
+format: install ## Format python code
+	ruff format src
+
+.PHONY: lint
+lint: install ## Lint python code
+	ruff check src
+
+.PHONY: install
+install: ## Setup project for development
+	pip install -e '.[webapp,test,dev]'
+
+
+.PHONY: test
+test: install ## Run unit tests
+	pytest
+
+.PHONY: help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+.DEFAULT_GOAL := help

README.md

@@ -1,40 +1,33 @@
 # shaclAPI
 
-Web server wrapping the TopBraid Shacl API tool. 
-Implementated for Imaging Plaza. 
+Web server for RDF data validation, wrapping the TopBraid Shacl API tool. 
 Based on https://github.com/SDSC-ORD/shacl
 
 ## How to use it?
 
 
+### With docker
 
-## How to use docker?
+We provide a helper make recipe to build two docker images, a small "headless" version with only the REST server, and a larger image that bundles the REST server and a streamlit web application. These two images are differentiated by their tag: `<version>` vs `<version>-webapp`.
 
 ```
-docker build -t sdsc-ordes/shacl-api:latest . 
+make docker-build
 ```
 
-```
-docker run -it --rm -p 8000:15400 -p 8501:8501 sdsc-ordes/shacl-api:latest 
-docker run -it --rm -p 7200:15400 -p 3000:8501 sdsc-ordes/shacl-api:latest 
-```
+The docker images can be run as follows:
 
 ```
-docker-compose up # add -d for detached
+# Only REST API
+docker run -it --rm -p 8000:15400 sdsc-ordes/shacl-api:latest 
+# REST API + web server
+docker run -it --rm -p 8000:15400 -p 8501:8501 sdsc-ordes/shacl-api:latest-webapp
 ```
 
-## LOGS
 
-```
-if [ $1 == validate ] ; then
-	set -- shaclvalidate.sh "$@"
-elif [ $1 == infer ] ; then
-	set -- shaclinfer.sh "$@"
-```
+## With docker compose
+
+For development, it may be more convenient to use our docker compose stack.
 
 ```
-root@cbb169b97823:/# shaclvalidate.sh
-Missing -datafile, e.g.: -datafile myfile.ttl
-root@cbb169b97823:/# shaclinfer.sh
-Missing -datafile, e.g.: -datafile myfile.ttl
+make docker-compose-up
 ```