Merge pull request #4 from intterra-io/enh/MSN-335

[MSN-335] Airborne DSA Revival

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+## Ticket
+
+[JIR-123](https://intterragroup.atlassian.net/browse/JIR-123)
+
+## Background
+
+What's the intent of this PR? What problem does it solve?
+
+What's the scope of the work?
+
+## Code Review
+
+### Points of Focus
+
+What should reviewers pay particular attention to (new patterns implemented, questions about how something should work, other parts of the app impacted, etc.)?
+
+### Test Plan
+
+Describe how reviewers should know your code works as expected.
+
+1. Do this.
+2. Look at that.
+3. Done!
+
+## Optional Fun
+
+Add a GIF indicating how the PR makes you feel

.github/workflows/build.yml

@@ -0,0 +1,36 @@
+name: Builds
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools pyinstaller
+          python -m pip install .
+
+      - name: Build executable
+        run: |
+          pyinstaller --onefile main.py -n airborne-dsa
+
+      - name: Upload executable
+        uses: svenstaro/upload-release-action@2.7.0
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: dist/airborne-dsa.exe
+          asset_name: airborne-dsa-windows-amd64.exe
+          tag: ${{ github.ref }}

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip3 install .
+
+      - name: Run tests
+        run: python3 -m unittest

.gitignore

@@ -137,4 +137,8 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-*.txt
+*.txt
+
+# Custom
+missions
+config.json

.vscode/settings.json

@@ -1,4 +1,3 @@
 {
-    "python.linting.pylintEnabled": true,
-    "python.linting.enabled": true
+  "python.analysis.typeCheckingMode": "basic"
 }

README.md

@@ -1,14 +1,31 @@
 # airborne-dsa-lite
-Data shipping script for airborne products 
+
+Data shipping script for airborne products
+
+## Local Development
+
+### Prerequisites
+
+- Python 3 installed
+- Python 3 venv installed
+- `python3 -m venv env`
+- `source env/bin/activate`
+- `python3 -m pip install --upgrade pip setuptools pyinstaller`
+
+### Running locally
 
 ## Getting started
-* Make sure you have python 3 installed
-* `pip install awscli boto3`
-* `aws configure`
-* Set the correct bucket name in `settings.py`
 
-Run: `python main.py` or `intterra-airborne-dsa.bat`
+- `source env/bin/activate`
+- `python3 -m pip install -e .`
+- `python3 main.py`
+
+For running locally, add "storageMode": "local" to config.json
+
+## Generating build
 
-Drop KMLs or tifs (*.tif and *.tiff) into this directory
+- `pyinstaller main.py --onefile -n airborne-dsa`
 
+## Running unit tests
 
+- `python3 -m unittest`