initial commit

Author: bearddan2000

README.md

@@ -0,0 +1,37 @@
+# javascript-web-htmx-get-nunjunk-python-flask-api-surrealdb-simple
+
+## Description
+A demo of htmx using a python flask
+api to return contents of table from
+surrealdb.
+
+## Tech stack
+- htmx
+    - get
+    - ext
+    - swap
+    - target
+- nunjunk
+- python
+    - flask
+    - cors
+- surrealdb
+
+## Docker stack
+- httpd:latest
+- python:latest
+- surrealdb/surrealdb:latest
+
+## To run
+`sudo ./install.sh -u`
+- Available at http://localhost
+
+## To stop
+`sudo ./install.sh -d`
+
+## To see help
+`sudo ./install.sh -h`
+
+## Credit
+- [Htmx clientside template](https://htmx.org/extensions/client-side-templates/)
+- [Htmx rendering JSON](https://marcus-obst.de/blog/htmx-json-handling)

api/Dockerfile

@@ -0,0 +1,18 @@
+
+FROM python:latest
+
+COPY bin/ /app
+
+WORKDIR /app
+
+RUN pip install --upgrade pip
+
+RUN pip install -r requirements.txt
+
+ENV WAIT_VERSION 2.7.2
+
+ADD https://github.com/ufoscout/docker-compose-wait/releases/download/$WAIT_VERSION/wait /wait
+
+RUN chmod +x /wait
+
+CMD ["python", "app.py"]

api/bin/__init__.py

@@ -0,0 +1,61 @@
+from flask import Flask, request
+import logging
+from client import Endpoint
+from flask_cors import CORS
+
+app = Flask(__name__)
+CORS(app)
+
+logging.basicConfig(level=logging.INFO)
+
+@app.route('/')
+def smoke_test():
+    d = {'hello': 'world'}
+    return {'results': d}
+
+@app.route('/dog')
+async def get_all():
+    results = await endpoint.get_all()
+    return {'results': results}
+
+@app.route('/dog/breed/<string:breed>', methods=['GET', 'DELETE', 'POST'])
+async def filter_del_upd_by_breed(breed: str):
+    results = []
+    if request.method == 'GET':
+        results = await endpoint.filter_by('breed', breed)
+    elif request.method == 'DELETE':
+        results = await endpoint.delete('breed', breed)
+    elif request.method == 'POST':
+        results = await endpoint.update('breed', breed)
+    return {'results': results}
+
+@app.route('/dog/color/<string:color>', methods=['GET', 'DELETE', 'POST'])
+async def filter_del_upd_by_color(color: str):
+    results = []
+    if request.method == 'GET':
+        results = await endpoint.filter_by('color', color)
+    elif request.method == 'DELETE':
+        results = await endpoint.delete('color', color)
+    elif request.method == 'POST':
+        results = await endpoint.update('color', color)
+    return {'results': results}
+
+@app.route('/dog/my_id/<string:id>', methods=['GET', 'DELETE', 'POST'])
+async def filter_del_upd_by_id(id: str):
+    results = []
+    if request.method == 'GET':
+        results = await endpoint.filter_by('my_id', id)
+    elif request.method == 'DELETE':
+        results = await endpoint.delete('my_id', id)
+    elif request.method == 'POST':
+        results = await endpoint.update('my_id', id)
+    return {'results': results}
+
+@app.route('/dog/breed/<breed>/color/<color>', methods=['PUT'])
+async def ins_by_breed(breed: str, color: str):
+    results = await endpoint.insert(breed, color)
+    return {'results': results}
+
+if __name__ == "__main__":
+    endpoint = Endpoint()
+    app.run(host ='0.0.0.0', port = 5000, debug = True)

api/bin/app.py

@@ -0,0 +1,89 @@
+from surrealdb import Surreal
+import logging
+
+logging.basicConfig(level=logging.INFO)
+
+class SurrealClient:
+    
+    def __init__(self) -> None:
+        self.isSeeded = False
+
+    async def query(self, sql):
+        host = "db"
+        port = 8000
+        async with Surreal(f"ws://{host}:{port}/rpc") as db:
+            await db.signin({"user": "root", "pass": "pass"})
+            await db.use("test", "test")
+            x = await db.query(sql)
+            return x[0]['result']
+            
+
+    async def seed(self):
+        if self.isSeeded == True:
+            return
+        
+        results = []
+        records = [
+            { "breed": "Am Bulldog", "color": "White", "my_id": '1' },
+            { "breed": "Blue Tick", "color": "Grey", "my_id": '2' },
+            { "breed": "Labrador", "color": "Black", "my_id": '3' },
+            { "breed": "Gr Shepard", "color": "Brown", "my_id": '4' }
+        ]
+        for record in records:
+            sql = "insert into dog {"
+            for k, v in record.items():
+                sql += f"{k}: '{v}',"
+            sql += "};"
+            results.append(await self.query(sql))
+
+        self.isSeeded = True
+
+        return results
+
+class Endpoint:
+    """Create singleton"""
+    def __new__(cls):
+         if not hasattr(cls, 'instance'):
+             cls.instance = super(Endpoint, cls).__new__(cls)
+         return cls.instance
+    
+    def __init__(self) -> None:
+        self.client = SurrealClient()
+
+    async def get_all(self):
+        await self.client.seed()
+        sql = 'select * from dog'
+        return await self.client.query(sql)
+    
+    async def filter_by(self, filter, filter_val):
+        await self.client.seed()
+        sql = f'select * from dog where {filter} = "{filter_val}"'
+        return await self.client.query(sql)
+    
+    async def delete(self, filter, filter_val):
+        await self.client.seed()
+        sql = f'delete from dog where {filter} = "{filter_val}"'
+        await self.client.query(sql)
+        return await self.get_all()
+    
+    async def insert(self, new_breed, new_color):
+        await self.client.seed()
+        records = [
+            { "breed": new_breed, "color": new_color, "my_id": '0' }
+        ]
+
+        sql = ''
+        for record in records:
+            sql = "insert into dog {"
+            for k, v in record.items():
+                sql += f"{k}: '{v}',"
+            sql += "};"
+            await self.client.query(sql)
+        return await self.get_all()
+    
+    async def update(self, filter, filter_val):
+        await self.client.seed()
+        logging.info(f"filter: {filter}, value: {filter_val}")
+        sql = f"update dog set breed='updated', color='updated', my_id='99' where {filter} = '{filter_val}';"
+        await self.client.query(sql)
+        return await self.get_all()

api/bin/client.py

@@ -0,0 +1,4 @@
+Flask[async]
+flask-cors
+aioflask
+surrealdb

api/bin/requirements.txt

@@ -0,0 +1,32 @@
+version: "3.4"
+
+services:
+  web:
+    image: httpd:latest
+    volumes:
+      - ./web/bin:/usr/local/apache2/htdocs 
+    ports:
+      - 80:80
+      
+  db:
+    image: surrealdb/surrealdb:latest
+    command: start --log info --user root --pass pass file:/mydata
+    ports:
+      - 8000
+
+  api:
+    build: api
+    healthcheck:
+      test: "exit 0"
+    command: sh -c "/wait && python app.py"
+    environment:
+      - WAIT_HOSTS=db:8000
+      - WAIT_HOSTS_TIMEOUT=300
+      - WAIT_SLEEP_INTERVAL=30
+      - WAIT_HOST_CONNECT_TIMEOUT=30
+    depends_on:
+      - db
+    links:
+      - "db:db"
+    ports:
+      - "81:5000"

docker-compose.yml

@@ -0,0 +1,17 @@
+[2023-07-13 23:16:12 INFO]: install::setup-logging ended
+================
+[2023-07-13 23:16:12 INFO]: install::start-up started
+[2023-07-13 23:16:12 INFO]: install::start-up starting services
+[2023-07-13 23:18:01 INFO]: install::root-check started
+[2023-07-13 23:18:01 INFO]: install::root-check ended
+================
+[2023-07-13 23:18:01 INFO]: install::docker-check started
+[2023-07-13 23:18:01 INFO]: install::docker-check ended
+================
+[2023-07-13 23:18:01 INFO]: install::docker-compose-check started
+[2023-07-13 23:18:01 INFO]: install::docker-compose-check ended
+================
+[2023-07-13 23:18:01 INFO]: install::tear-down started
+[2023-07-13 23:18:01 INFO]: install::tear-down starting services
+[2023-07-13 23:18:01 INFO]: install::tear-down ended
+================