Merge pull request #48 from bedrock-engineer/dev

Release 0.3.0

Author: JoostGevaert

.github/workflows/python-tests.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ['3.9']
+        python-version: ['3.10', '3.12']
 
     steps:
     - name: Checkout code

.gitignore

@@ -6,6 +6,8 @@ __marimo__/
 **/log
 **/tmp
 **/temp
+examples/**/raw/
+examples/**/cleaned/
 
 # SQLite Databases
 *.sqlite

.python-version

@@ -0,0 +1 @@
+3.10

RELEASE.md

@@ -14,15 +14,19 @@ Update the version number in:
 - [`/src/bedrock/__init__.py`](/src/bedrock_ge/__init__.py)
 - Inline script dependencies of marimo notebooks in [`examples`](/examples/)
 
-## 2. Update the Changelog
+## 2. Update `uv.lock`
 
-Update `CHANGELOG.md` with details about the new release. Include any new features, bug fixes, or breaking changes.
+The version of `bedrock-ge` in the `uv.lock` file needs to be updated such that tests can run properly. Therefore run:
 
-## 3. Run Tests
+```bash
+uv sync --all-groups --upgrade
+```
+
+## 3. PR `dev` → `main`
 
-Ensure that all tests pass by running your test suite.
+Open a pull request (PR) from `dev` to `main`.
 
-To automate this, it's possible to set up a CI (Continuous Integration) pipeline to confirm everything works in multiple environments, e.g. with `GitHub Actions`.
+This also runs the automated tests.
 
 ## 4. Commit the Changes
 
@@ -33,15 +37,11 @@ git add .
 git commit -m "Release version X.Y.Z"
 ```
 
-## 5. Prepare for Merge
-
-Open a pull request (PR) from `dev` to `main`.
-
-## 6. Merge `dev` into `main`
+## 5. Merge `dev` into `main`
 
 Once everything is ready, and the PR is approved, merge `dev` into `main`. This officially brings all the changes in `dev` into the release-ready `main` branch.
 
-## 7. Tag the Release
+## 6. Tag the Release
 
 Create a Git tag for the new version:
 
@@ -51,14 +51,20 @@ git tag X.Y.Z
 git push origin X.Y.Z
 ```
 
-## 8. Build the Distribution
+## 7. Build the Distribution
 
 Create source and wheel distributions:
 
 ```bash
 uv build
 ```
 
+This creates a `bedrock_ge-X.Y.Z.tar.gz` file (source) and a `bedrock_ge-X.Y.Z-py3-none-any.whl` file (wheel) in the `/dist` folder.
+
+## 8. Remove the old distribution
+
+In order for the `uv publish` command to work properly, only one version of the distriution can be inside the `/dist` folder. Therefore delete the old source and wheel files.
+
 ## 9. Publish to PyPI
 
 1. Set the `UV_PUBLISH_TOKEN` environment variable. Copy from `.env`.
@@ -69,10 +75,6 @@ set UV_PUBLISH_TOKEN=pypi-blablabla
 uv publish
 ```
 
-> ⚠️ **Attention:**
->
-> You might have to delete previous distributions of the Python package in `dist/*`
-
 ## 10. Verify the Release
 
 Check that the new version is available on PyPI:  

examples/hk_kaitak_ags3/hk_kaitak_ags3_to_brgi_geodb.ipynb

@@ -1,13 +1,13 @@
 [project]
 name = "bedrock-ge"
-version = "0.2.4"
+version = "0.3.0"
 description = "Bedrock's Python library for geotechnical engineering."
 authors = [
     {name = "Bedrock", email = "[email protected]"}
 ]
 license = {text = "Apache Software License (Apache 2.0)"}
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
     "geopandas~=1.0",
     "openpyxl~=3.0",
@@ -55,7 +55,6 @@ classifiers = [
     "Topic :: Scientific/Engineering",
     "Topic :: Scientific/Engineering :: GIS",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -72,21 +71,17 @@ Tracker = "https://github.com/bedrock-engineer/bedrock-ge/issues"
 
 [dependency-groups]
 dev = [
-    "duckdb>=1.2.2",
-    "folium>=0.17.0",
     "frictionless[excel]>=4.40.8",
-    "jupyter>=1.1.1",
-    "mapclassify>=2.8.1",
-    "marimo>=0.12.5",
-    "matplotlib>=3.9.2",
+    "marimo[recommended]>=0.13.11",
     "mypy>=1.11.2",
-    "nbconvert>=7.16.6",
     "pandas-stubs>=2.2.2.240807",
-    "ruff>=0.6.7",
-    "sqlglot>=26.12.1",
 ]
 
 tests = [
+    "folium>=0.17.0",
+    "mapclassify>=2.8.1",
+    "marimo>=0.13.11",
+    "matplotlib>=3.9.2",
     "pytest>=8.3.3",
 ]