added gunicorn dep and delpy gh action

Author: theodoremoreland

.dockerignore

@@ -1,3 +1,5 @@
 **/__pycache__/
 **/venv/
-**/*.example**
+**/*.example**
+**/*.log**
+**/*.zip**

.github/workflows/camo-purge.yml

@@ -0,0 +1,52 @@
+name: Deploy to Lightsail
+
+permissions:
+  id-token: write
+  contents: read
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Build Docker image
+        run: docker build -t hawaii-climate-data-api:latest .
+
+      - name: Upgrade AWS CLI version and setup lightsailctl
+        run: |
+          aws --version
+          curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
+          unzip awscliv2.zip
+          sudo ./aws/install --bin-dir /usr/local/bin --install-dir /usr/local/aws-cli --update
+          which aws
+          aws --version
+          sudo curl "https://s3.us-west-2.amazonaws.com/lightsailctl/latest/linux-amd64/lightsailctl" -o "/usr/local/bin/lightsailctl"
+          sudo chmod +x /usr/local/bin/lightsailctl
+
+      - name: Configure AWS credentials using OIDC
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ secrets.AWS_ROLE_NAME }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Push to Lightsail
+        run: |
+          aws lightsail push-container-image \
+            --service-name hawaii-climate-data-api-container-service \
+            --label hawaii-climate-data-api \
+            --image hawaii-climate-data-api:latest
+
+      - name: Deploy container to Lightsail
+        run: |
+          aws lightsail create-container-service-deployment \
+            --service-name hawaii-climate-data-api-container-service \
+            --containers file://containers.json \
+            --public-endpoint file://endpoint.json \
+            --region ${{ secrets.AWS_REGION }}

.github/workflows/deploy.yaml

@@ -5,4 +5,4 @@ WORKDIR /application
 COPY application/ ./
 RUN pip install -r requirements.txt
 
-CMD [ "python", "application.py" ]
+CMD ["gunicorn", "--chdir", "/application", "application:application", "--bind", "0.0.0.0:5000"]

docker/dev.Dockerfile Dockerfiledocker/dev.Dockerfile renamed to Dockerfile

@@ -8,33 +8,34 @@ _This project was for an assignment at Washington University's Data Analytics Bo
 
 ## Table of contents
 
--   [Technologies Used](#technologies-used)
--   [How to run locally](#how-to-run-locally)
-    -   [Run on Windows](#run-on-windows)
-    -   [Run on Docker](#run-on-docker)
--   [Screenshots](#screenshots)
-    -   [API](#Climate-API)
-        -   [Desktop](#desktop)
-        -   [Mobile](#mobile)
-    -   [Analysis](#Analysis)
+- [Technologies Used](#technologies-used)
+- [How to run locally](#how-to-run-locally)
+  - [Run on Windows](#run-on-windows)
+  - [Run on Docker](#run-on-docker)
+- [Screenshots](#screenshots)
+  - [API](#climate-api)
+    - [Desktop](#desktop)
+    - [Mobile](#mobile)
+  - [Analysis](#analysis)
 
 ## Technologies used
 
--   Python
--   HTML
--   CSS
--   Jupyter Notebook
--   Matplotlib
--   Pandas
--   Flask
--   Black
--   VS Code
--   Docker
+- Python
+- HTML
+- CSS
+- Jupyter Notebook
+- Matplotlib
+- Pandas
+- Flask
+- Black
+- gunicorn
+- VS Code
+- Docker
 
 ## How to run locally
 
--   If you are trying to run this application directly on a Windows OS, you will need to install `Python 3.11`.
--   Otherwise, you will need to install Docker so you can run the application through Docker.
+- If you are trying to run this application directly on a Windows OS, you will need to install `Python 3.11`. You will also likely have to install Visual Studio and Microsoft C++ Build Tools.
+- Alternatively, the recommended way is to install Docker so you can run the application through Docker.
 
 ### Run on Windows
 
@@ -44,55 +45,49 @@ Assumes you are using a modern Windows client OS such as Windows 11 or Windows 1
 
 Open terminal at root of this project then move into application/ directory:
 
-```
+```bash
 cd application/
 ```
 
 Create venv folder in application folder using Python 3.11:
 
-```
+```bash
 python3.11 -m venv venv
 ```
 
 Activate venv:
 
-```
+```bash
 source venv/Scripts/activate
 ```
 
 Install python packages to venv:
 
-```
+```bash
 pip install -r requirements.txt
 ```
 
 Start application:
 
-```
+```bash
 python application.py
 ```
 
 ### Run on Docker
 
-Firstly, confirm that Docker is installed and running. Next confirm that no other application is using port `5000` as port `5000` is needed for the Flask server. If you need to run Flask on an alternative port, you can modify the last line in the `application/application.py` file and the ports in the `docker/docker-compose.yml` file.
+Firstly, confirm that Docker is installed and running. Next confirm that no other application is using port `5000` as port `5000` is needed for the Flask server. If you need to run Flask on an alternative port, you can modify the last line in the `application/application.py` file and the ports in the `docker-compose.yml` file.
 
 **It is assumed the user is at the root of this project and is using a UNIX style command line environment when referencing the CLI commands below.**
 
-Open terminal at root of this project then move into docker/ directory:
-
-```
-cd docker/
-```
-
 Build Docker image and start Docker container:
 
-```
+```bash
 docker compose up --build
 ```
 
-Visit: http://localhost:5000 to use the application.
+Visit: <http://localhost:5000> to use the application.
 
-# Screenshots
+## Screenshots
 
 ## Climate API
 
@@ -174,15 +169,15 @@ Visit: http://localhost:5000 to use the application.
 
 ---
 
-## Analysis
+### Analysis
 
-### Precipitation summary statistics (within 12 month range)
+#### Precipitation summary statistics (within 12 month range)
 
 <img src="presentation/plot1.png" width="900">
 
 <img src="presentation/stats.PNG" width="200">
 
-### Last 12 months of temperature observation data (tobs)
+#### Last 12 months of temperature observation data (tobs)
 
 <img src="presentation/plot2.png" width="900">
 

README.md

@@ -3,6 +3,7 @@ blinker==1.6.2
 click==8.1.7
 Flask==3.0.0
 greenlet==3.0.0
+gunicorn==23.0.0
 itsdangerous==2.1.2
 Jinja2==3.1.6
 MarkupSafe==2.1.3

application/requirements.txt

@@ -0,0 +1,8 @@
+{
+  "hawaii-climate-data-api": {
+    "image": ":hawaii-climate-data-api-container-service.hawaii-climate-data-api.latest",
+    "ports": {
+      "5000": "HTTP"
+    }
+  }
+}

containers.json

@@ -0,0 +1,10 @@
+version: "3"
+
+services:
+  hawaii-climate-data-api--container-service:
+    container_name: hawaii-climate-data-api
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    ports:
+      - 5000:5000

docker-compose.yml

@@ -0,0 +1,11 @@
+{
+  "containerName": "hawaii-climate-data-api",
+  "containerPort": 5000,
+  "healthCheck": {
+    "path": "/",
+    "intervalSeconds": 5,
+    "timeoutSeconds": 2,
+    "healthyThreshold": 2,
+    "unhealthyThreshold": 2
+  }
+}