Create package, support web_app target

Deltares-research · Jan 17, 2025 · a7bfc3d · a7bfc3d
1 parent f0ec775
commit a7bfc3d
Show file tree

Hide file tree

Showing 40 changed files with 283 additions and 359 deletions.
diff --git a/.github/workflows/analyse.yml b/.github/workflows/analyse.yml
@@ -17,7 +17,7 @@ jobs:
       matrix:
         python_version: ["3.12"]
         platform:
-          - { os: "ubuntu-22.04", arch: x64 }
+          - { os: "ubuntu-24.04", arch: x64 }
     steps:
       - name: Checkout
         uses: actions/checkout@v4

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -21,7 +21,7 @@ jobs:
         platform:
           - { os: "macos-14", arch: arm64 }
           - { os: "macos-13", arch: x64 }
-          - { os: "ubuntu-22.04", arch: x64 }
+          - { os: "ubuntu-24.04", arch: x64 }
           - { os: "windows-2022", arch: x64 }
     steps:
       - name: Setup Linux platform

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -7,6 +7,14 @@ project(AdaptationPathways
     HOMEPAGE_URL "https://publicwiki.deltares.nl/display/AP/Adaptation+Pathways"
 )
 
+set(AP_COPYRIGHT "2025 by TODO")
+string(JOIN ", " AP_AUTHORS
+    # TODO Add everybody, in some order (alphabet?)
+    "Kor de Jong (Geoneric, NL)"
+    "Marjolijn Haasnoot (Deltares, NL)"
+    "Willem van Deursen (Carthago Consultancy, NL)"
+)
+
 enable_testing()
 
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/environment/cmake)

diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
@@ -30,7 +30,7 @@ add_custom_target(apidoc
                     --module-first
                     -d 1
                     -o ${CMAKE_CURRENT_BINARY_DIR}/api
-                    ${PROJECT_SOURCE_DIR}/source/package/adaptation_pathways
+                    ${PROJECT_SOURCE_DIR}/source/package
 )
 
 # https://www.sphinx-doc.org/en/master/man/sphinx-build.html

diff --git a/documentation/conf.py.in b/documentation/conf.py.in
@@ -11,15 +11,8 @@ import re
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "@CMAKE_PROJECT_NAME@"
-copyright = "2024, TODO"
-author = ", ".join(
-    [
-        # TODO Add everybody
-        "Marjolijn Haasnoot (Deltares, NL)",
-        "Willem van Deursen (Carthago Consultancy, NL)",
-        "Kor de Jong (Geoneric, NL)",
-    ]
-)
+copyright = "@AP_COPYRIGHT@"
+author = "@AP_AUTHORS@"
 version = "@CMAKE_PROJECT_VERSION_MAJOR@.@CMAKE_PROJECT_VERSION_MINOR@"
 
 # -- General configuration ---------------------------------------------------

diff --git a/environment/configuration/requirements-dev.txt b/environment/configuration/requirements-dev.txt
@@ -1,6 +1,7 @@
 build
 cairosvg
 cmake
+flet>=0.25.1
 furo
 linkchecker
 ninja

diff --git a/environment/configuration/requirements.txt b/environment/configuration/requirements.txt
@@ -2,4 +2,3 @@ docopt
 matplotlib
 networkx[default]
 pyside6>=6.6
-flet==0.22.*
diff --git a/pyproject.toml b/pyproject.toml
@@ -34,11 +34,10 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "docopt",
+    # "docopt",  # TODO flet build can't find docopt...
     "matplotlib",
     "networkx[default]",
-    "pyside6",
-    "flet",
+    # "pyside6",
 ]
 
 [project.urls]

diff --git a/source/CMakeLists.txt b/source/CMakeLists.txt
@@ -1,2 +1,3 @@
 add_subdirectory(package/adaptation_pathways/desktop)
+add_subdirectory(package/pathways_app)
 add_subdirectory(test)
diff --git a/source/package/pathways_app/.gitignore b/source/package/pathways_app/.gitignore
diff --git a/source/package/pathways_app/CMakeLists.txt b/source/package/pathways_app/CMakeLists.txt
@@ -0,0 +1,24 @@
+find_program(AP_FLET_COMMAND flet REQUIRED)
+
+
+configure_file(
+    pyproject.toml.in
+    pyproject.toml
+    @ONLY
+)
+
+add_custom_target(web_app
+    COMMAND
+        ${CMAKE_COMMAND} -E copy_directory_if_different
+            ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}
+    COMMAND
+        ${CMAKE_COMMAND} -E env "PIP_FIND_LINKS=file://${PROJECT_BINARY_DIR}/dist"
+            ${AP_FLET_COMMAND} build web ${CMAKE_CURRENT_BINARY_DIR}
+    COMMAND
+        ${CMAKE_COMMAND} -E echo
+            "Run a command like this to start the web app:"
+            "${Python3_EXECUTABLE} -m http.server --directory ${CMAKE_CURRENT_BINARY_DIR}/build/web"
+    DEPENDS
+        package
+    VERBATIM
+)
diff --git a/source/package/pathways_app/README.md b/source/package/pathways_app/README.md
@@ -3,11 +3,21 @@
 To run the app from within this directory:
 
 ```
-flet run .
+flet run main.py
 ```
 
 To run the app as a website:
 
 ```
-flet run --web .
+flet run --web
+```
+
+To build the web app:
+
+```
+# Assumes you're in the binary directory
+cmake --build . --target web_app
+
+# Alternatively, if using Ninja for example
+ninja web_app
 ```