Merge pull request #30 from bedrock-engineer/test-kaitak-hk-notebook-bed-26

Test kaitak hk notebook and set up automated testing with GitHub actions

Author: JoostGevaert

.github/workflows/python-tests.yml

@@ -0,0 +1,33 @@
+name: Run Python tests
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.9']
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install bedrock-ge with testing dependencies
+      run: uv sync --locked --group tests   
+
+    - name: Run tests
+      run: uv run pytest tests

.python-version

@@ -0,0 +1,7 @@
+{
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

.vscode/settings.json

@@ -12,6 +12,7 @@ Update the version number in:
 
 - [`pyproject.toml`](pyproject.toml)
 - [`/src/bedrock/__init__.py`](/src/bedrock/__init__.py)
+- Inline script dependencies of marimo notebooks in [`examples`](/examples/)
 
 ## 2. Update the Changelog
 

RELEASE.md

@@ -1,7 +1,7 @@
 # /// script
 # requires-python = ">=3.12"
 # dependencies = [
-#     "bedrock-ge==0.2.2",
+#     "bedrock-ge==0.2.3",
 #     "chardet==5.2.0",
 #     "folium==0.19.5",
 #     "geopandas==1.0.1",
@@ -167,7 +167,7 @@ def _(mo):
 
         ### From GI dataframe to `geopandas.GeoDataFrame` 
 
-        In order to construct the 3D simple feature GIS geometry of the `Location`s, `Sample`s and `InSitu_TEST`s, a few more columns have to be calcualated for each of these tables: `elevation_at_top` and `elevation_at_base` if the in-situ test or sample was taken over a depth interval.
+        In order to construct the 3D simple feature GIS geometry of the `Location`s, `Sample`s and `InSitu_TEST`s, a few more columns have to be calculated for each of these tables: `elevation_at_top` and `elevation_at_base` if the in-situ test or sample was taken over a depth interval.
 
         The 3D simple feature GIS geometry as [WKT](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) for point tests and samples:  
         `POINT (easting northing elevation_at_top)`
@@ -341,7 +341,7 @@ def _(mo):
 
         <iframe title="Speckle" src="https://app.speckle.systems/projects/013aaf06e7/models/1cbe68ed69,44c8d1ecae,9535541c2b,a739490298,ff81bfa02b#embed=%7B%22isEnabled%22%3Atrue%7D" width="100%" height="400" frameborder="0"></iframe>
 
-        Additionally, you can load the GI data in other software that Speckle has a connector for, such as Rhino / Grasshopper to enable parameteric geotechnical engineering workflows.
+        Additionally, you can load the GI data in other software that Speckle has a connector for, such as Rhino / Grasshopper to enable parametric geotechnical engineering workflows.
         """
     )
     return
@@ -410,7 +410,7 @@ def zip_of_ags3s_to_bedrock_gi_database(zip, crs):
                     )
                     check_no_gis_brgi_database(brgi_db_from_1_ags3_file)
                     print(
-                        f"\n✅ Succesfully converted {file_name} to Bedrock GI database and validated!\n"
+                        f"\n✅ Successfully converted {file_name} to Bedrock GI database and validated!\n"
                     )
                     print(
                         f"🧵 Concatenating Bedrock GI database for {file_name} to existing Bedrock GI database...\n"

examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.py

@@ -69,12 +69,9 @@ Source = "https://github.com/bedrock-engineer/bedrock-ge"
 Documentation = "https://bedrock.engineer/docs/"
 Tracker = "https://github.com/bedrock-engineer/bedrock-ge/issues"
 
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
 
-[tool.uv]
-dev-dependencies = [
+[project.optional-dependencies]
+dev = [
     "duckdb>=1.2.2",
     "folium>=0.17.0",
     "frictionless[excel]>=4.40.8",
@@ -85,11 +82,18 @@ dev-dependencies = [
     "mypy>=1.11.2",
     "nbconvert>=7.16.6",
     "pandas-stubs>=2.2.2.240807",
-    "pytest>=8.3.3",
     "ruff>=0.6.7",
     "sqlglot>=26.12.1",
 ]
 
+tests = [
+    "pytest>=8.3.3",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
 [tool.ruff]
 line-length = 88
 

examples/hk_kaitak_ags3/kaitak_gi.gpkg

@@ -1,2 +1,4 @@
 def hello_plt() -> None:
-    print("Hello from src/bedrock/plot.py!")
+    print(
+        "Hi Bedrock engineer! bedrock_ge.plot is a placeholder module for Geotechnical Engineering plots."
+    )