Merge pull request #1 from alphagov/github_actions

Added CI github action

Author: minglis

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - ".git**"
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install uv
+    - name: Test with pytest
+      run: |
+        uv run pytest

.gitignore

@@ -8,6 +8,7 @@ wheels/
 
 # Virtual environments
 .venv
+.idea
 .env
 graph.json
-outputs/
+outputs/

.python-version

@@ -1 +1 @@
-3.12
+3.13

Dockerfile

@@ -17,7 +17,6 @@ RUN uv sync --no-dev --no-install-project
 
 COPY src/ ./src/
 COPY app.py ./app.py
-COPY graph.json ./graph.json
 
 
 

README.md

@@ -0,0 +1,79 @@
+# GOV.UK AI Graph Tools
+
+TODO: Fill in project description
+
+## Local Setup
+
+---
+
+### Prerequisites
+
+- **Python 3.13** - managed via `uv`
+- **uv** — Python package manager
+
+Install `uv` if not already installed:
+
+```bash
+brew install uv
+# or
+pip install uv
+```
+
+---
+
+### 1. Install dependencies
+
+```bash
+uv init --python 3.13
+uv python pin 3.13
+uv add -r requirements.txt
+```
+
+### 2. Run the app
+
+**Debug mode (Flask dev server):**
+
+```bash
+uv run app.py
+```
+
+**Production mode (Waitress WSGI server):**
+
+```bash
+uv run waitress-serve --port 3000 --call 'app:create_app'
+```
+
+The app runs on **http://localhost:3000**.
+
+---
+
+
+### 3. Docker run
+
+Build and run using Docker:
+
+```bash
+docker build -t govuk-ai-graph-tools-app .
+
+docker run -p 3000:3000 -t govuk-ai-graph-tools-app
+```
+
+---
+
+
+## Tests
+
+```bash
+uv run pytest
+```
+
+---
+
+## Licence
+
+[MIT LICENCE](LICENCE)
+
+
+
+
+

app.py

@@ -19,10 +19,10 @@
 def create_app():
     app = Flask(__name__)
 
-    @app.route('/health', methods=['GET'])
+    @app.route('/healthcheck/ready', methods=['GET'])
     def health_check():
         """Simple health check endpoint."""
-        return jsonify({"status": "healthy"}), 200
+        return "Application OK", 200
 
     @app.route('/extract', methods=['GET'])
     async def extract_quotes():

pyproject.toml

@@ -13,7 +13,7 @@ dependencies = [
     "s3fs>=0.4.2",
     "opensearch-py>=2.8.0",
     "requests-aws4auth>=1.3.1",
-    "flask[async]>=3.0.0",
+    "flask[async]==3.1.2",
     "waitress>=3.0.0",
 ]
 

tests/__init__.py

@@ -0,0 +1,19 @@
+import pytest
+import importlib
+import sys
+from werkzeug.test import Client
+from werkzeug.wrappers import Response
+
+def _app_module():
+    return importlib.import_module("app")
+
+
+def _client():
+    return Client(_app_module().create_app(), Response)
+
+def test_healthcheck_ready_route():
+    response = _client().get("/healthcheck/ready")
+
+    assert response.status_code == 200
+    body = response.get_data(as_text=True)
+    assert 'Application OK' in body