Merge pull request #13 from nsidc/clean

Code/comment cleanup and reorganization

Author: trey-stafford

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.4.0
+
+- Reorganize code to make it clearer what routes serve EDD vs the python script.
+- Improve Swagger API docs.
+
 # v0.3.0
 
 - Add flask-cors, using the same config that hermes-api did. Allow all nsidc.org

Dockerfile

@@ -13,4 +13,4 @@ RUN mkdir -p /tmp/ssl && /opt/conda/bin/openssl req -x509 -nodes -days 365 -newk
 
 EXPOSE 5000
 
-CMD /bin/bash -c "gunicorn --certfile=/tmp/ssl/dat.crt --keyfile=/tmp/ssl/dat.key --bind 0.0.0.0:5000 --workers 9 dat_backend.app:app"
+CMD /bin/bash -c "gunicorn --certfile=/tmp/ssl/dat.crt --keyfile=/tmp/ssl/dat.key --bind 0.0.0.0:5000 --workers 9 dat_backend:app"

docker-compose.dev.yml

@@ -3,7 +3,7 @@ services:
     build: .
     volumes:
       - "./src:/tmp/"
-    command: '/bin/bash -c "PYTHONPATH=./ python dat_backend/app.py"'
+    command: '/bin/bash -c "PYTHONPATH=./ python dat_backend/dev_server.py"'
 
   server:
     build: ./nginx

docker-compose.production.yml

@@ -1,5 +1,5 @@
 services:
   api:
-    image: "ghcr.io/nsidc/data-access-tool-api:v0.3.0"
+    image: "ghcr.io/nsidc/data-access-tool-api:v0.4.0"
   server:
-    image: "ghcr.io/nsidc/data-access-tool-server:v0.3.0"
+    image: "ghcr.io/nsidc/data-access-tool-server:v0.4.0"

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "data-access-tool-backend"
-version = "0.3.0"
+version = "0.4.0"
 authors = [
   { name = "NSIDC", email = "nsidc@nsidc.org" },
 ]
@@ -36,7 +36,7 @@ ignore_missing_imports = true
 
 
 [too.bumpversion]
-current_version = "0.3.0"
+current_version = "0.4.0"
 commit = false
 tag = false
 
@@ -49,3 +49,8 @@ replace  = ':v{new_version}'
 filename = "pyproject.toml"
 search = 'version = "{current_version}"'
 replace = 'version = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "src/dat_backend/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'

src/dat_backend/__init__.py

@@ -0,0 +1,44 @@
+import os
+import logging
+import re
+
+import flask_restx as frx
+from flask import Flask
+from flask_cors import CORS
+
+from dat_backend.reverse_proxy import ReverseProxied
+
+__version__ = "0.4.0"
+
+app = Flask(__name__)
+# Enable CORS, allowing all nsidc.org domains.
+CORS(
+    app,
+    origins=[re.compile(r"^https?:\/\/(.*\.)?nsidc\.org")],
+    expose_headers=["content-disposition"],
+    supports_credentials=True,
+)
+api = frx.Api(
+    app,
+    version=__version__,
+    title="Data Access Tool API",
+    description="Backend services for the Data Access Tool.",
+)
+
+app.wsgi_app = ReverseProxied(app.wsgi_app)  # type: ignore[method-assign]
+
+app.logger.setLevel(logging.INFO)
+
+secret_key = os.environ.get("DAT_FLASK_SECRET_KEY")
+app.secret_key = secret_key
+
+
+# Imports of modules containing routes come after . This is necessary so that all of the
+# APIs are defined when this file is done initializing.
+from dat_backend.routes.earthdata_download import auth, get_links  # noqa
+from dat_backend.routes import status, python_script  # noqa
+
+if __name__ == "__main__":
+    # `ssl_context` option:
+    # https://werkzeug.palletsprojects.com/en/2.3.x/serving/#werkzeug.serving.run_simple
+    app.run(host="0.0.0.0", debug=True, ssl_context="adhoc")