language_reference now builds in docker and ci

calaldees · calaldees · commit d2c3b8215bfa · 2026-02-15T19:46:31.000Z
api can be used to build only the parts it has the path's for (project and/or language_reference)
update all language workflows to not regen on `make_ver` (that was heavy and not related)
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,4 @@
+**/.venv
+*.py[cod]
+**/__*/**
+api/
diff --git a/.github/workflows/deploy_language_reference.yml b/.github/workflows/deploy_language_reference.yml
@@ -5,9 +5,10 @@ on:
     branches:
       - main
     paths:
-      - ".github/workflows/deploy_website.yml"
+      - ".github/workflows/deploy_language_reference.yml"
       - "make_ver/**"
       - "language_reference/**"
+      - "static/language_reference.html"
 
 jobs:
   deploy:
@@ -18,5 +19,16 @@ jobs:
       #- name: run_languages
       #  run: make --directory language_reference build_and_run
 
-      #- name: build_static
-      #  run: (cd teachprogramming/lib && make build_static)
+      - name: build_static
+        run: make build_language_reference_docker
+
+      # - name: rsync deployments
+      #   uses: burnett01/rsync-deployments@v8
+      #   with:
+      #     switches: -avzr --delete
+      #     path: api/
+      #     remote_path: ${{ secrets.REMOTE_PATH }} # ex: /var/www/html/
+      #     remote_host: ${{ secrets.REMOTE_HOST }} # ex: example.com
+      #     remote_port: ${{ secrets.REMOTE_PORT }} # ex: 22
+      #     remote_user: ${{ secrets.REMOTE_USER }} # ex: ubuntu
+      #     remote_key: ${{ secrets.REMOTE_PRIVATE_KEY }}
diff --git a/.github/workflows/language_reference_c.yml b/.github/workflows/language_reference_c.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_c.yml"
-      - "make_ver/**"
       - "language_reference/languages/c"
 
 jobs:
diff --git a/.github/workflows/language_reference_csharp.yml b/.github/workflows/language_reference_csharp.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_csharp.yml"
-      - "make_ver/**"
       - "language_reference/languages/csharp"
 
 jobs:
diff --git a/.github/workflows/language_reference_golang.yml b/.github/workflows/language_reference_golang.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_golang.yml"
-      - "make_ver/**"
       - "language_reference/languages/golang"
 
 jobs:
diff --git a/.github/workflows/language_reference_java.yml b/.github/workflows/language_reference_java.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_java.yml"
-      - "make_ver/**"
       - "language_reference/languages/java"
 
 jobs:
diff --git a/.github/workflows/language_reference_javascript.yml b/.github/workflows/language_reference_javascript.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_javascript.yml"
-      - "make_ver/**"
       - "language_reference/languages/javascript"
 
 jobs:
diff --git a/.github/workflows/language_reference_lua.yml b/.github/workflows/language_reference_lua.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_lua.yml"
-      - "make_ver/**"
       - "language_reference/languages/lua"
 
 jobs:
diff --git a/.github/workflows/language_reference_php.yml b/.github/workflows/language_reference_php.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_php.yml"
-      - "make_ver/**"
       - "language_reference/languages/php"
 
 jobs:
diff --git a/.github/workflows/language_reference_python.yml b/.github/workflows/language_reference_python.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_python.yml"
-      - "make_ver/**"
       - "language_reference/languages/python"
 
 jobs:
diff --git a/.github/workflows/language_reference_ruby.yml b/.github/workflows/language_reference_ruby.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_ruby.yml"
-      - "make_ver/**"
       - "language_reference/languages/ruby"
 
 jobs:
diff --git a/.github/workflows/language_reference_rust.yml b/.github/workflows/language_reference_rust.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_rust.yml"
-      - "make_ver/**"
       - "language_reference/languages/rust"
 
 jobs:
diff --git a/.github/workflows/language_reference_vb.yml b/.github/workflows/language_reference_vb.yml
@@ -6,7 +6,6 @@ on:
       - main
     paths:
       - ".github/workflows/language_reference_vb.yml"
-      - "make_ver/**"
       - "language_reference/languages/vb"
 
 jobs:
diff --git a/Makefile b/Makefile
@@ -1,16 +1,32 @@
+DOCKER_IMAGE_LANGUAGE_REFERENCE:=language_reference
 
 serve_falcon:
 	./api.py \
 		--path_static   static/ \
 		--path_language language_reference/languages/ \
 		--path_project  ~/code/personal/TeachProgramming/teachprogramming/static/projects/
 
-build:
+build_all_local: clean
+	# Projects are currently in a different repo and will be re-thought
 	./api.py \
-		--path_static   static/ \
 		--path_language language_reference/languages/ \
 		--path_project  ~/code/personal/TeachProgramming/teachprogramming/static/projects/ \
- 		--export        .
+ 		--path_export   .
 
-serve:
+serve_build_local:
 	python3 -m http.server
+
+build_language_reference_local: clean
+	./api.py \
+		--path_language language_reference/languages/ \
+ 		--path_export   .
+
+build_language_reference_docker: clean
+	docker build --file build_language_reference.Dockerfile --tag ${DOCKER_IMAGE_LANGUAGE_REFERENCE} .
+	docker create --name=${DOCKER_IMAGE_LANGUAGE_REFERENCE}_container ${DOCKER_IMAGE_LANGUAGE_REFERENCE}
+	docker cp ${DOCKER_IMAGE_LANGUAGE_REFERENCE}_container:/app/api api/
+	docker container rm ${DOCKER_IMAGE_LANGUAGE_REFERENCE}_container
+
+clean:
+	docker container rm ${DOCKER_IMAGE_LANGUAGE_REFERENCE}_container --force
+	rm -rf api
diff --git a/api.py b/api.py
@@ -97,36 +97,43 @@ def _filter_file(f):
 
 # Setup App -------------------------------------------------------------------
 
-def create_wsgi_app(path_project: Path, path_language: Path, path_static: Path, **kwargs):
+def create_wsgi_app(path_project: Path|None, path_language: Path|None, path_static: Path|None, **kwargs):
     app = falcon.App()
-    app.add_route(r'/', IndexResource())
-    app.add_static_route(r'/static', str(path_static.resolve()))
-    app.add_route(r'/api/v1/language_reference.json', LanguageReferenceResource(path_language))
-    app.add_route(r'/api/v1/projects.json', ProjectListResource(path_project))
-    _falcon_helpers.add_sink(app, r'/api/v1/projects/', ProjectResource(path_project), func_path_normalizer=_falcon_helpers.func_path_normalizer_no_extension)
     _falcon_helpers.update_json_handlers(app)
+    app.add_route(r'/', IndexResource())
+    if path_static:
+        app.add_static_route(r'/static', str(path_static.resolve()))
+    if path_language:
+        app.add_route(r'/api/v1/language_reference.json', LanguageReferenceResource(path_language))
+    if path_project:
+        app.add_route(r'/api/v1/projects.json', ProjectListResource(path_project))
+        _falcon_helpers.add_sink(app, r'/api/v1/projects/', ProjectResource(path_project), func_path_normalizer=_falcon_helpers.func_path_normalizer_no_extension)
     # TODO: Currently unable to drop into debugger on error - investigate?
     # https://falcon.readthedocs.io/en/stable/api/app.html#falcon.App.add_error_handler
     # add_error_handler(exception, handler=None)
     return app
 
 # Export ----------------------------------------------------------------------
 
-def export(output_path: Path = Path()) -> None:
+def export(path_export: Path, path_language: Path, path_project: Path, **kwargs) -> None:
     from falcon import testing as falcon_testing
     test_client = falcon_testing.TestClient(app)
-    def read_write(url):
+
+    def write_url_to_file(url):
         log.info(url)
-        file_path = output_path.joinpath(url.strip('/'))
+        file_path = path_export.joinpath(url.strip('/'))
         file_path.parent.mkdir(parents=True, exist_ok=True)
         with file_path.open('wt', encoding="utf-8") as filehandle:
             data = test_client.simulate_get(url)
             filehandle.write(data.text)
             return data.json
-    read_write('/api/v1/language_reference.json')
-    projects = read_write('/api/v1/projects.json')['projects']
-    for project in projects:
-        read_write(f'/api/v1/projects/{project}.json')
+
+    if path_language:
+        write_url_to_file('/api/v1/language_reference.json')
+    if path_project:
+        projects = write_url_to_file('/api/v1/projects.json')['projects']
+        for project in projects:
+            write_url_to_file(f'/api/v1/projects/{project}.json')
 
 
 # Commandlin Args -------------------------------------------------------------
@@ -141,14 +148,14 @@ def get_args():
         ''',
     )
 
-    parser.add_argument('--path_project', action='store', default='./', help='', type=Path)
-    parser.add_argument('--path_language', action='store', default='./', help='', type=Path)
-    parser.add_argument('--path_static', action='store', default='./', help='', type=Path)
+    parser.add_argument('--path_project', action='store', help='', type=Path)
+    parser.add_argument('--path_language', action='store', help='', type=Path)
+    parser.add_argument('--path_static', action='store', help='', type=Path)
 
     parser.add_argument('--host', action='store', default='0.0.0.0', help='')
     parser.add_argument('--port', action='store', default=8000, type=int, help='')
 
-    parser.add_argument('--export', action='store', default=None, type=Path)
+    parser.add_argument('--path_export', action='store', default=None, type=Path)
 
     parser.add_argument('--log_level', action='store', type=int, help='loglevel of output to stdout', default=logging.INFO)
 
@@ -165,8 +172,8 @@ def get_args():
     from wsgiref import simple_server
     app = create_wsgi_app(**kwargs)
 
-    if kwargs['export']:
-        export(kwargs['export'])
+    if kwargs['path_export']:
+        export(**kwargs)
         exit()
 
     try:
diff --git a/build_language_reference.Dockerfile b/build_language_reference.Dockerfile
@@ -0,0 +1,7 @@
+FROM astral/uv:python3.14-alpine AS base
+ENV UV_PROJECT_ENVIRONMENT=/.uv.venv
+ENV UV_NO_SYNC=True
+WORKDIR /app/
+RUN uv venv && uv pip install falcon
+COPY . .
+RUN uv run api.py --path_language language_reference/languages/ --path_export .
diff --git a/language_reference/generate_github_workflows.py b/language_reference/generate_github_workflows.py
@@ -28,7 +28,6 @@
       - main
     paths:
       - ".github/workflows/language_reference_$LANGUAGE.yml"
-      - "make_ver/**"
       - "language_reference/languages/$LANGUAGE"
 
 jobs:
diff --git a/make_ver/pyproject.toml b/make_ver/pyproject.toml
@@ -4,9 +4,6 @@
     description = ""
     readme = "README.md"
     requires-python = ">= 3.14"
-    dependencies = [
-        "falcon",
-    ]
 
 [dependency-groups]
     dev = [
