feat: Update readme

.gitea/workflows/build.yml

@@ -33,9 +33,13 @@ jobs:
             tag_num="${tag}-${tag_num}"
           fi
           
+          repo=$GITHUB_REPOSITORY
+          repo=${repo#*/}
+          repo=$(echo $repo | tr '[:upper:]' '[:lower:]')
+          echo "container=$repo"
           
-          docker build -t nathanwoodburn:$tag_num .
+          docker build -t $repo:$tag_num .
-          docker tag nathanwoodburn:$tag_num git.woodburn.au/nathanwoodburn/nathanwoodburn:$tag_num
+          docker tag $repo:$tag_num git.woodburn.au/nathanwoodburn/$repo:$tag_num
-          docker push git.woodburn.au/nathanwoodburn/nathanwoodburn:$tag_num
+          docker push git.woodburn.au/nathanwoodburn/$repo:$tag_num
-          docker tag nathanwoodburn:$tag_num git.woodburn.au/nathanwoodburn/nathanwoodburn:$tag
+          docker tag $repo:$tag_num git.woodburn.au/nathanwoodburn/$repo:$tag
-          docker push git.woodburn.au/nathanwoodburn/nathanwoodburn:$tag
+          docker push git.woodburn.au/nathanwoodburn/$repo:$tag

Dockerfile

@@ -1,17 +1,31 @@
-FROM --platform=$BUILDPLATFORM python:3.10-alpine AS builder
+FROM --platform=$BUILDPLATFORM python:3.13-alpine
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
 
+# Install curl for healthcheck
+RUN apk add --no-cache curl
+
+# Set working directory
 WORKDIR /app
 
-COPY requirements.txt /app
+# Install dependencies
-RUN --mount=type=cache,target=/root/.cache/pip \
+RUN --mount=type=cache,target=/root/.cache/uv \
-    python3 -m pip install -r requirements.txt
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project
 
-COPY . /app
+# Copy the project into the image
+ADD . /app
 
-# Optionally mount /data to store the data
+# Sync the project
-# VOLUME /data
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked
 
-ENTRYPOINT ["python3"]
+# Add mount point for data volume
+ENV BASE_DIR=/data
+VOLUME /data
+
+EXPOSE 5000
+
+
+ENTRYPOINT ["uv", "run"]
 CMD ["main.py"]
-
-FROM builder as dev-envs

README.md

@@ -2,17 +2,31 @@
 
 Python3 website template including git actions
 
-# Development
+## Requirements
-1. Install requirements
+- UV
+
+## Development
+1. Install project requirements
 ```bash
-python3 -m pip install -r requirements.txt
+uv sync
 ```
 2. Run the dev server
 ```bash
-python3 server.py
+uv run python3 server.py
+```
+3. Alternatively use the virtual environment
+```bash
+source .venv/bin/activate
+```
+You can exit the environment with `deactivate`
+
+For best development setup, you should install the git hook for pre-commit
+```bash
+uv run pre-commit install
 ```
 
-# Production
+
+## Production
 Run using the main.py file
 ```bash
 python3 main.py

main.py

@@ -1,5 +1,3 @@
-from flask import Flask
-from server import app
 import server
 from gunicorn.app.base import BaseApplication
 import os
@@ -21,22 +19,20 @@ class GunicornApp(BaseApplication):
         return self.application
 
 
-
+if __name__ == "__main__":
-
-if __name__ == '__main__':
     dotenv.load_dotenv()
 
-    workers = os.getenv('WORKERS', 1)
+    workers = os.getenv("WORKERS", 1)
-    threads = os.getenv('THREADS', 2)
+    threads = os.getenv("THREADS", 2)
     workers = int(workers)
     threads = int(threads)
 
     options = {
-        'bind': '0.0.0.0:5000',
+        "bind": "0.0.0.0:5000",
-        'workers': workers,
+        "workers": workers,
-        'threads': threads,
+        "threads": threads,
     }
 
     gunicorn_app = GunicornApp(server.app, options)
-    print(f'Starting server with {workers} workers and {threads} threads', flush=True)
+    print(f"Starting server with {workers} workers and {threads} threads", flush=True)
     gunicorn_app.run()

server.py

@@ -1,9 +1,6 @@
-from functools import cache
-import json
 from flask import (
     Flask,
     make_response,
-    redirect,
     request,
     jsonify,
     render_template,
@@ -11,7 +8,6 @@ from flask import (
     send_file,
 )
 import os
-import json
 import requests
 from datetime import datetime
 import dotenv
@@ -26,6 +22,7 @@ def find(name, path):
         if name in files:
             return os.path.join(root, name)
 
+
 # Assets routes
 @app.route("/assets/<path:path>")
 def send_assets(path):
@@ -74,17 +71,13 @@ def wellknown(path):
 # region Main routes
 @app.route("/")
 def index():
-    # Get current time in the format "dd MMM YYYY hh:mm AM/PM"
-    # current_datetime = datetime.now().strftime("%d %b %Y %I:%M %p")
-    # return render_template("index.html", datetime=current_datetime)
-    
     # Print the IP address of the requester
     print(f"Request from IP: {request.remote_addr}")
     # And the headers
     print(f"Request headers: {request.headers}")
-
+    # Get current time in the format "dd MMM YYYY hh:mm AM/PM"
-
+    current_datetime = datetime.now().strftime("%d %b %Y %I:%M %p")
-    # return redirect("https://ya.c.woodburn.au")
+    return render_template("index.html", datetime=current_datetime)
 
 
 @app.route("/<path:path>")
@@ -116,6 +109,7 @@ def catch_all(path: str):
 
 api_requests = 0
 
+
 @app.route("/api/v1/data", methods=["GET"])
 def api_data():
     """