Merge pull request #1 from joshuasundance-swca/connor

.github/workflows/docker-hub.yml

@@ -23,9 +23,10 @@ jobs:
     - name: Build Docker image
       run: |
         docker build \
-          -t joshuasundance/geospatial_data_converter:${{ github.ref_name }} \
-          -t joshuasundance/geospatial_data_converter:latest \
+          --target runtime \
+          -t joshuasundance/geospatial-data-converter:${{ github.ref_name }} \
+          -t joshuasundance/geospatial-data-converter:latest \
           .
 
     - name: Push to Docker Hub
-      run: docker push -a joshuasundance/geospatial_data_converter
+      run: docker push -a joshuasundance/geospatial-data-converter

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.11-slim-bookworm
+FROM python:3.11-slim-bookworm AS base
 
 RUN adduser --uid 1000 --disabled-password --gecos '' appuser
 USER 1000
@@ -10,11 +10,18 @@ ENV PYTHONDONTWRITEBYTECODE=1 \
 RUN pip install --user --no-cache-dir --upgrade pip
 COPY ./requirements.txt /home/appuser/requirements.txt
 RUN pip install --user --no-cache-dir  --upgrade -r /home/appuser/requirements.txt
+COPY geospatial-data-converter/ /home/appuser/geospatial-data-converter/
 
-COPY geospatial_data_converter/ /home/appuser/geospatial_data_converter/
-COPY tests/ /home/appuser/tests/
+
+FROM base AS test
+
+COPY dev-requirements.txt /home/appuser/dev-requirements.txt
+RUN pip install --user --no-cache-dir --upgrade -r /home/appuser/dev-requirements.txt
+
+
+FROM base AS runtime
 
 WORKDIR /workspace
 EXPOSE 7860
 
-CMD ["streamlit", "run", "/home/appuser/geospatial_data_converter/app.py", "--server.port", "7860", "--server.address", "0.0.0.0", "--server.enableXsrfProtection=false"]
+CMD ["streamlit", "run", "/home/appuser/geospatial-data-converter/app.py", "--server.port", "7860", "--server.address", "0.0.0.0", "--server.enableXsrfProtection=false"]

README.md

@@ -13,17 +13,17 @@ tags: [geospatial, streamlit, docker]
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![python](https://img.shields.io/badge/Python-3.11-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
-![GitHub tag (with filter)](https://img.shields.io/github/v/tag/joshuasundance-swca/geospatial_data_converter)
+![GitHub tag (with filter)](https://img.shields.io/github/v/tag/joshuasundance-swca/geospatial-data-converter)
 
-[![Push to Docker Hub](https://github.com/joshuasundance-swca/geospatial_data_converter/actions/workflows/docker-hub.yml/badge.svg)](https://github.com/joshuasundance-swca/geospatial_data_converter/actions/workflows/docker-hub.yml)
-[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/joshuasundance/geospatial_data_converter/latest)](https://hub.docker.com/r/joshuasundance/geospatial_data_converter)
+[![Push to Docker Hub](https://github.com/joshuasundance-swca/geospatial-data-converter/actions/workflows/docker-hub.yml/badge.svg)](https://github.com/joshuasundance-swca/geospatial-data-converter/actions/workflows/docker-hub.yml)
+[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/joshuasundance/geospatial-data-converter/latest)](https://hub.docker.com/r/joshuasundance/geospatial-data-converter)
 
-[![Push to HuggingFace Space](https://github.com/joshuasundance-swca/geospatial_data_converter/actions/workflows/hf-space.yml/badge.svg)](https://github.com/joshuasundance-swca/geospatial_data_converter/actions/workflows/hf-space.yml)
-[![Open HuggingFace Space](https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/joshuasundance/geospatial_data_converter)
+[![Push to HuggingFace Space](https://github.com/joshuasundance-swca/geospatial-data-converter/actions/workflows/hf-space.yml/badge.svg)](https://github.com/joshuasundance-swca/geospatial-data-converter/actions/workflows/hf-space.yml)
+[![Open HuggingFace Space](https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/joshuasundance/geospatial-data-converter)
 
-![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/joshuasundance-swca/geospatial_data_converter)
-![Code Climate issues](https://img.shields.io/codeclimate/issues/joshuasundance-swca/geospatial_data_converter)
-![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/joshuasundance-swca/geospatial_data_converter)
+![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/joshuasundance-swca/geospatial-data-converter)
+![Code Climate issues](https://img.shields.io/codeclimate/issues/joshuasundance-swca/geospatial-data-converter)
+![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/joshuasundance-swca/geospatial-data-converter)
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)
@@ -31,7 +31,7 @@ tags: [geospatial, streamlit, docker]
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
-![Known Vulnerabilities](https://snyk.io/test/github/joshuasundance-swca/geospatial_data_converter/badge.svg)
+![Known Vulnerabilities](https://snyk.io/test/github/joshuasundance-swca/geospatial-data-converter/badge.svg)
 
 This project showcases a simple geospatial data converter using [Streamlit](https://streamlit.io) and [GeoPandas](https://geopandas.org/).
 
@@ -45,11 +45,11 @@ This project showcases a simple geospatial data converter using [Streamlit](http
 - Download button for the converted data
 
 # Deployment
-`geospatial_data_converter` is deployed as a [Docker image](https://hub.docker.com/r/<your-dockerhub-username>/geospatial_data_converter) based on the `python:3.11-slim-bookworm` image.
+`geospatial-data-converter` is deployed as a [Docker image](https://hub.docker.com/r/<your-dockerhub-username>/geospatial-data-converter) based on the `python:3.11-slim-bookworm` image.
 
 ## With Docker (pull from Docker Hub)
 1. Run in terminal:
-`docker run -p 7860:7860 <your-dockerhub-username>/geospatial_data_converter:latest`
+`docker run -p 7860:7860 <your-dockerhub-username>/geospatial-data-converter:latest`
 2. Open http://localhost:8501 in your browser
 
 ## Docker Compose (build locally)
@@ -63,7 +63,7 @@ This project showcases a simple geospatial data converter using [Streamlit](http
 ## Kubernetes
 1. Clone the repo. Navigate to cloned repo directory
 2. Run bash script: `/bin/bash ./kubernetes/deploy.sh`
-3. Get the IP address for your new service: `kubectl get service geospatial_data_converter`
+3. Get the IP address for your new service: `kubectl get service geospatial-data-converter`
 
 # Links
 - [Streamlit](https://streamlit.io)

dev-requirements.txt

@@ -0,0 +1,2 @@
+pytest==7.4.3
+pytest-cov==4.1.0

docker-compose.yml

@@ -1,21 +1,23 @@
 version: '3.8'
 
 services:
-  geospatial_data_converter:
-    image: geospatial_data_converter:latest
-    build: .
-    ports:
-      - "${APP_PORT:-7860}:${APP_PORT:-7860}"
-    working_dir: /workspace
-    command: [
-      "streamlit", "run",
-      "/home/appuser/geospatial_data_converter/app.py",
-      "--server.port", "${APP_PORT:-7860}",
-      "--server.address", "0.0.0.0",
-      "--server.enableXsrfProtection=false"
-    ]
   test:
-    image: geospatial_data_converter:latest  # Use the same image as your main service
-    build: .
+    container_name: geospatial-data-converter-test
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: test
+    volumes:
+      - ./tests/:/home/appuser/tests/
+      - ./pyproject.toml:/home/appuser/pyproject.toml
     working_dir: /home/appuser
-    command: ["/bin/bash"]
+    command: ["pytest"]
+
+  geospatial-data-converter:
+    container_name: geospatial-data-converter
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: runtime
+    ports:
+      - "${APP_PORT:-7860}:${APP_PORT:-7860}"

{geospatial_data_converter → geospatial-data-converter}/app.py

@@ -6,10 +6,7 @@ import streamlit as st
 from aiohttp import ClientSession
 from restgdf import FeatureLayer
 
-try:
-    from utils import read_file, convert, output_format_dict
-except ImportError:
-    from .utils import read_file, convert, output_format_dict
+from utils import read_file, convert, output_format_dict
 
 __version__ = "0.2.1"
 

{geospatial_data_converter → geospatial-data-converter}/utils.py

@@ -5,10 +5,7 @@ from tempfile import TemporaryDirectory
 from typing import BinaryIO
 import geopandas as gpd
 
-try:
-    from kml_tricks import load_ge_data
-except ImportError:
-    from .kml_tricks import load_ge_data
+from kml_tricks import load_ge_data
 
 output_format_dict = {
     "ESRI Shapefile": ("shp", "zip", "application/zip"),  # must be zipped

kubernetes/resources.yaml

@@ -1,20 +1,20 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: geospatial_data_converter-deployment
+  name: geospatial-data-converter-deployment
 spec:
   replicas: 1
   selector:
     matchLabels:
-      app: geospatial_data_converter
+      app: geospatial-data-converter
   template:
     metadata:
       labels:
-        app: geospatial_data_converter
+        app: geospatial-data-converter
     spec:
       containers:
-      - name: geospatial_data_converter
-        image: joshuasundance/geospatial_data_converter:0.1.1
+      - name: geospatial-data-converter
+        image: joshuasundance/geospatial-data-converter:0.1.1
         imagePullPolicy: Always
         resources:
           requests:
@@ -29,15 +29,15 @@ spec:
 apiVersion: v1
 kind: Service
 metadata:
-  name: geospatial_data_converter-service
+  name: geospatial-data-converter-service
   # configure on Azure and uncomment below to use a vnet
 #  annotations:
 #    service.beta.kubernetes.io/azure-load-balancer-internal: "true"
 #    service.beta.kubernetes.io/azure-load-balancer-ipv4: vnet.ip.goes.here
-#    service.beta.kubernetes.io/azure-dns-label-name: "geospatial_data_converter"
+#    service.beta.kubernetes.io/azure-dns-label-name: "geospatial-data-converter"
 spec:
   selector:
-    app: geospatial_data_converter
+    app: geospatial-data-converter
   ports:
     - protocol: TCP
       port: 80
@@ -47,11 +47,11 @@ spec:
 apiVersion: networking.k8s.io/v1
 kind: NetworkPolicy
 metadata:
-  name: geospatial_data_converter-network-policy
+  name: geospatial-data-converter-network-policy
 spec:
   podSelector:
     matchLabels:
-      app: geospatial_data_converter
+      app: geospatial-data-converter
   policyTypes:
   - Ingress
   ingress:

bumpver.toml → pyproject.toml

@@ -1,4 +1,9 @@
-[bumpver]
+[tool.pytest.ini_options]
+pythonpath = ["geospatial-data-converter"]
+testpaths = ["tests"]
+addopts = "--cov=geospatial-data-converter"
+
+[tool.bumpver]
 current_version = "0.2.1"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "bump version {old_version} -> {new_version}"
@@ -10,9 +15,9 @@ commit = true
 tag = true
 push = true
 
-[bumpver.file_patterns]
+[tool.bumpver.file_patterns]
 "bumpver.toml" = [
     'current_version = "{version}"',
 ]
-"geospatial_data_converter/app.py" = ['__version__ = "{version}"']
-"kubernetes/resources.yaml" = ['        image: joshuasundance/geospatial_data_converter:{version}']
+"geospatial-data-converter/app.py" = ['__version__ = "{version}"']
+"kubernetes/resources.yaml" = ['        image: joshuasundance/geospatial-data-converter:{version}']

requirements.txt

@@ -3,6 +3,5 @@ beautifulsoup4==4.12.2
 geopandas==0.14.1
 lxml==4.9.3
 pyogrio==0.7.2
-pytest
 restgdf==0.9.7
 streamlit==1.29.0

tests/test_conversions.py

@@ -1,6 +1,6 @@
 import os
 import pytest
-from geospatial_data_converter.utils import convert, read_file
+from utils import convert, read_file
 
 input_exts = ["kml", "kmz", "geojson", "zip"]
 output_exts = ["KML", "ESRI Shapefile", "GeoJSON", "CSV", "OpenFileGDB"]