✨(project) add data7-based opendata service

We need to publish dynamic datasets for:

* "statique" data (charge points)
* "dynamique" data (charge point statuses)

Makefile

@@ -60,6 +60,10 @@ build-notebook: ## build custom jupyter notebook image
 	@$(COMPOSE) build notebook
 .PHONY: build-notebook
 
+build-opendata: ## build opendata image
+	@$(COMPOSE) build opendata
+.PHONY: build-opendata
+
 down: ## stop and remove all containers
 	@$(COMPOSE) down
 .PHONY: down
@@ -76,18 +80,26 @@ logs-notebook: ## display notebook logs (follow mode)
 	@$(COMPOSE) logs -f notebook
 .PHONY: logs-notebook
 
+logs-opendata: ## display opendata logs (follow mode)
+	@$(COMPOSE) logs -f opendata
+.PHONY: logs-opendata
+
 run: ## run the api server (and dependencies)
 	$(COMPOSE) up -d api
 .PHONY: run
 
 run-all: ## run the whole stack
-	$(COMPOSE) up -d api keycloak metabase notebook
+	$(COMPOSE) up -d api keycloak metabase notebook opendata
 .PHONY: run-all
 
 run-notebook: ## run the notebook service
 	$(COMPOSE) up -d notebook
 .PHONY: run-notebook
 
+run-opendata: ## run the opendata service
+	$(COMPOSE) up -d opendata
+.PHONY: run-opendata
+
 status: ## an alias for "docker compose ps"
 	@$(COMPOSE) ps
 .PHONY: status

bin/data7

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+declare DOCKER_USER
+DOCKER_UID="$(id -u)"
+DOCKER_GID="$(id -g)"
+DOCKER_USER="${DOCKER_UID}:${DOCKER_GID}"
+
+DOCKER_USER=${DOCKER_USER} \
+  DOCKER_UID=${DOCKER_UID} \
+  DOCKER_GID=${DOCKER_GID} \
+  docker compose run --rm opendata pipenv run data7 "$@"

bin/pipenv

@@ -2,4 +2,6 @@
 
 set -eo pipefail
 
-docker compose run --rm --no-deps -u "pipenv:pipenv" api pipenv "$@"
+declare service="${SERVICE:-api}"
+
+docker compose run --rm --no-deps -u "pipenv:pipenv" "${service}" pipenv "$@"

docker-compose.yml

@@ -87,6 +87,23 @@ services:
     depends_on:
       - postgresql
 
+  opendata:
+    build:
+      context: ./src/opendata
+      args:
+        DOCKER_UID: ${DOCKER_UID:-1000}
+        DOCKER_GID: ${DOCKER_GID:-1000}
+    user: ${DOCKER_USER:-1000}
+    image: "qualicharge:opendata"
+    ports:
+      - "8020:8000"
+    env_file:
+      - env.d/opendata
+    volumes:
+      - ./src/opendata:/app
+    depends_on:
+      - postgresql
+
   # -- tools
   curl:
     image: curlimages/curl:8.8.0

env.d/opendata

@@ -0,0 +1,4 @@
+ENV_FOR_DYNACONF=development
+DATA7_DATABASE_URL=postgresql+asyncpg://qualicharge:pass@postgresql:5432/qualicharge-api
+DATA7_HOST=0.0.0.0
+DATA7_PORT=8000

src/opendata/.secrets.yaml

@@ -0,0 +1,9 @@
+#
+# Data7 secrets.
+#
+
+# Will be set via environment variables
+
+# ---- DEFAULT ---------------------------------
+default:
+  DATABASE_URL: ""

src/opendata/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Configured Data7 0.5.0
+
+[unreleased]: https://github.com/MTES-MCT/qualicharge/

src/opendata/Dockerfile

@@ -0,0 +1,47 @@
+# -- Base image --
+FROM python:3.12-slim
+
+ARG DOCKER_UID 1000
+ARG DOCKER_GID 1000
+
+# Upgrade system packages to install security updates
+RUN apt-get update && \
+    apt-get -y upgrade && \
+    rm -rf /var/lib/apt/lists/*
+
+# Upgrade pip to its latest release to speed up dependencies
+# installation
+RUN pip install --upgrade pip && \
+    pip install pipenv==2024.0.1
+
+# Pipenv configuration
+ENV PIPENV_USER_UID ${DOCKER_UID}
+ENV PIPENV_USER_GID ${DOCKER_GID}
+ENV PIPENV_USER_NAME pipenv
+ENV PIPENV_GROUP_NAME pipenv
+ENV PIPENV_USER_HOME /opt/pipenv/
+ENV PIPENV_CUSTOM_VENV_NAME qualicharge
+
+# Create a pipenv user and group
+RUN groupadd \
+      -g ${PIPENV_USER_GID} \
+      ${PIPENV_GROUP_NAME} && \
+    useradd -rm \
+      -d ${PIPENV_USER_HOME} \
+      -s /bin/bash \
+      -u ${PIPENV_USER_UID} \
+      -g ${PIPENV_USER_GID} \
+      ${PIPENV_USER_NAME}
+
+# /app will be our working directory
+RUN mkdir /app && \
+    chown ${PIPENV_USER_NAME}:${PIPENV_GROUP_NAME} /app
+
+# -- build (⚠️ development only) --
+COPY --chown="${PIPENV_USER_NAME}:${PIPENV_GROUP_NAME}" . /app
+WORKDIR /app
+USER ${PIPENV_USER_NAME}:${PIPENV_GROUP_NAME}
+RUN pipenv install -de .
+
+# -- Run --
+CMD pipenv run honcho start

src/opendata/Pipfile

@@ -0,0 +1,15 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+data7 = "==0.5.0"
+databases = {extras = ["asyncpg"], version = "==0.9.0"}
+
+[dev-packages]
+honcho = "==1.1.0"
+setuptools = "==70.1.1"
+
+[requires]
+python_version = "3.12"