Upgrade Dependencies, Status Endpoint, and GitHub Actions (#17)

Author: bbengfort

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,35 +4,34 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the bug**
+
 A clear and concise description of what the bug is.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
 **Expected behavior**
+
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
+
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]
  - Version [e.g. 22]
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
 **Additional context**
+
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,17 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 **Describe the solution you'd like**
+
 A clear and concise description of what you want to happen.
 
 **Describe alternatives you've considered**
+
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
+
 Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request.md

@@ -0,0 +1,32 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+This PR fixes #issue_number _(If you are fixing a bug)_ which reported a bug that caused a problem to occur when users...
+
+_(or if you are introducing a new feature)_ which requested a feature to allow the user to...
+
+## Description
+
+<!--- Describe your changes in detail -->
+
+## How has this been tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, tests ran to see how -->
+<!--- your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+
+## Still to do:
+
+<!--
+If this is a work-in-progress (WIP), list the changes you still need to make and/or questions or the reviewer(s). You can also mention extensions to your work that might be added as an issue to work on after the PR.
+-->
+
+- [ ]
+- [ ]
+- [ ]
+
+## Questions for the reviewer(s):
+
+- [ ]
+- [ ]

.github/SECURITY.md

@@ -0,0 +1,23 @@
+# Open Source Security Policies and Procedures
+
+This document outlines security procedures and general policies for the
+Georgetown-Analytics Open Source projects as found on
+https://github.com/georgetown-analytics.
+
+## Reporting a Vulnerability
+
+The Georgetown Data Science faculty and community take all security
+vulnerabilities seriously. Thank you for improving the security of our
+open source software. We appreciate your efforts and responsible
+disclosure and will make every effort to acknowledge your contributions.
+
+Report security vulnerabilities by emailing the Georgetown faculty at:
+
+    pdcprograms@georgetown.edu
+
+After the initial reply to your report, the facutly team will endeavor to
+keep you informed of the progress towards a fix and full announcement, and
+may ask for additional information or guidance.
+
+Report security vulnerabilities in third-party modules to the person or
+team maintaining the module.

.github/workflows/containers.yaml

@@ -0,0 +1,64 @@
+name: Containers
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  data-space:
+    name: Data Space
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Setup Environment
+        id: vars
+        run: |
+          echo "::set-output name=tag::${GITHUB_REF#refs/*/}"
+          echo "::set-output name=revision::$(git rev-parse --short HEAD)"
+
+      - name: Docker Metadata
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          # list of Docker images to use as basenames for tags
+          # this should be configured for each container built
+          images: |
+            bbengfort/data-space
+          tags: |
+            type=semver,pattern={{raw}}
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=sha,prefix=,suffix=,format=short
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Setup Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }}
+
+      - name: Build and Push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            GIT_REVISION=${{ steps.vars.outputs.revision }}

.github/workflows/tests.yaml

@@ -0,0 +1,29 @@
+name: Tests
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+
+jobs:
+  lint:
+    name: Flake8
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install Flake8
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install flake8
+
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Lint Python Code
+        run: flake8 --ignore=E501,F401,E266 .

.gitignore

@@ -102,3 +102,5 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+.vscode

Dockerfile

@@ -1,6 +1,7 @@
 # Dynamic Builds
-ARG BUILDER_IMAGE=python:3.8-slim-buster
-ARG FINAL_IMAGE=python:3.8-slim-buster
+ARG BUILDER_IMAGE=python:3.11-slim-buster
+ARG FINAL_IMAGE=python:3.11-slim-buster
+ARG GIT_REVISION=""
 
 # Build Stage
 FROM ${BUILDER_IMAGE} AS builder
@@ -22,7 +23,7 @@ RUN flake8 --ignore=E501,F401,E266 .
 
 # Build dependencies into wheels
 COPY ./requirements.txt .
-RUN python3 -m pip install numpy==1.16.4 cython
+RUN python3 -m pip install numpy==1.23.4 cython
 RUN python3 -m pip wheel --no-cache-dir --wheel-dir /usr/src/app/wheels -r requirements.txt
 
 # Final Stage

Procfile

@@ -26,6 +26,7 @@
 
 from numpy import asarray
 from functools import partial
+from datetime import datetime
 
 from sklearn.svm import SVC
 from sklearn.preprocessing import MinMaxScaler
@@ -52,6 +53,9 @@
 
 app = Flask(__name__)
 
+version = "v1.1.0"
+started = datetime.now()
+
 
 ##########################################################################
 ## Routes
@@ -153,6 +157,15 @@ def fit():
     })
 
 
+@app.route("/status", methods=["GET"])
+def status():
+    return jsonify({
+        "status": "ok",
+        "version": version,
+        "uptime": (datetime.now() - started).total_seconds(),
+    })
+
+
 ##########################################################################
 ## Run the Web App
 ##########################################################################