🔄 Synced file(s) with devstream-io/devstream

Author: daniel-hutao

.gitignore

@@ -0,0 +1,14 @@
+.venv/
+
+*.pyc
+__pycache__/
+
+instance/
+
+.pytest_cache/
+.coverage
+htmlcov/
+
+dist/
+build/
+*.egg-info/

Dockerfile.tpl

@@ -0,0 +1,14 @@
+FROM python:3.10-alpine
+
+WORKDIR /code
+
+COPY ./requirements.txt /code/requirements.txt
+
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+
+COPY ./wsgi.py /code/
+COPY ./app /code/app
+
+USER 1000
+
+CMD ["gunicorn", "--conf", "app/gunicorn.conf.py", "--bind", "0.0.0.0:8080", "wsgi:app"]

README.md

@@ -1 +1,35 @@
-# dtm-repo-scaffolding-python-flask
+# dtm-repo-scaffolding-python-flask
+
+This repo contains templates used by DevStream plugin "repo-scaffolding" (thereafter: the plugin).
+
+This repo isn't intended to be used directly without DevStream. It should only be consumed by the plugin automatically.
+
+The plugin (together with this repo of templates) can create a repo in GitHub and set up the project layout and initialize the reop with necessary files that are typical for a Go web app. The followings can be created automatically:
+
+- a Python web app example using the Flask framework
+- directory structure, following Flask/Python best practice
+- `.gitignore`, suggested by Flask
+- Dockerfile with Python alpline
+- a simplified Helm chart with Deployment and Service
+
+## Usage
+
+- Render all files using go template whose name end with `.tpl` suffix.
+- Files whose name don't end with `.tpl` extension don't need to be rendered.
+- subdirectory "helm/**_app_name_**" (the **_app_name_** part) should be rendered with `AppName`
+- subdicrectory "cmd/**_app_name_**" (the **_app_name_** part) should be rendered with `AppName`
+
+Example of required parameters to render these templates:
+
+```yaml
+AppName: hello
+Repo:
+  Owner: ironcore864
+  Name: hello
+imageRepo: ironcore864/hello # dockerhub
+```
+
+## Where does this repo come from?
+
+`dtm-repo-scaffolding-python-flask` is synced from https://github.com/devstream-io/devstream/blob/main/staging/dtm-repo-scaffolding-python-flask. 
+Code changes are made in that location, merged into `devstream-io/devstream` and later synced here.

README.md.tpl

@@ -0,0 +1,19 @@
+# [[.AppName]]
+
+This is a repo for app [[.AppName]]; bootstrapped by DevStream.
+
+By default, the automatically generated scaffolding contains:
+
+- a piece of sample Python [Flask](https://flask.palletsprojects.com/en/2.2.0/) web app
+- sample unittest
+- .gitignore
+- requirements.txt
+- wsgi.py
+- Dockerfile
+- Helm chart
+
+## Test
+
+```shell
+python3 -m unittest
+```

app/_app_name_.py.tpl

@@ -0,0 +1,12 @@
+from flask import Flask
+
+app = Flask(__name__)
+
+
+@app.route("/")
+def hello():
+    return "Hello, World!"
+
+
+if __name__ == "__main__":
+    app.run(host='0.0.0.0')

app/gunicorn.conf.py.tpl

@@ -0,0 +1,9 @@
+# Gunicorn config variables
+loglevel = "info"
+errorlog = "-"  # stderr
+accesslog = "-"  # stdout
+worker_tmp_dir = "/dev/shm"
+graceful_timeout = 120
+timeout = 120
+keepalive = 5
+threads = 3

requirements.txt.tpl

@@ -0,0 +1,2 @@
+Flask==2.2.0
+gunicorn==20.1.0

test/__init__.py

@@ -0,0 +1 @@
+

test/__init__.py.tpl

@@ -0,0 +1,12 @@
+import unittest
+
+from app.[[.AppName]] import hello
+
+
+class TestHello(unittest.TestCase):
+    def test_hello(self):
+        self.assertEqual(hello(), "Hello, World!")
+
+
+if __name__ == '__main__':
+    unittest.main()

test/test__app_name_.py.tpl

@@ -0,0 +1,4 @@
+from app.[[.AppName]] import app
+
+if __name__ == "__main__":
+    app.run()