Merge pull request #8 from tonkintaylor/develop

v0.1.0

Author: nathanjmcdougall

.github/workflows/ci.yml

@@ -75,11 +75,11 @@ jobs:
           MPLBACKEND: Agg # https://github.com/orgs/community/discussions/26434
 
       - name: Create test reports directory
-        if: matrix.pytest && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
+        if: matrix.pytest && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10' && matrix.resolution == 'highest'
         run: mkdir -p ./test-reports
 
       - name: Upload coverage reports
-        if: matrix.pytest && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13'
+        if: matrix.pytest && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10' && matrix.resolution == 'highest'
         uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
         with:
           name: coverage-reports
@@ -126,7 +126,7 @@ jobs:
           cat > sonar-project.properties << EOF
           sonar.projectKey=${SONAR_PROJECT_KEY}
           sonar.language=py
-          sonar.python.version=3.13
+          sonar.python.version=3.10
           sonar.sources=./src
           sonar.tests=./tests
           sonar.python.coverage.reportPaths=./test-reports/coverage.xml

.python-version

@@ -1 +1 @@
-3.12.11
+3.10.18

README.md

@@ -1,14 +1,14 @@
-<a href="https://github.com/tonkintaylor/geopins/"><img src="https://raw.githubusercontent.com/tonkintaylor/geopins/refs/heads/develop/docs/logo.svg" align="right" height="138" /></a>
-
-<!--  -->
 # geopins
+<a href="https://github.com/tonkintaylor/geopins/"><img src="https://raw.githubusercontent.com/tonkintaylor/geopins/refs/heads/develop/docs/logo.svg" align="right" height="138" /></a>
 
 [![PyPI Version](https://img.shields.io/pypi/v/geopins.svg)](<https://pypi.python.org/pypi/geopins>)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![usethis](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/usethis-python/usethis-python/main/assets/badge/v1.json)](https://github.com/usethis-python/usethis-python)
 
-Geospatial support for the [Python pins package](https://github.com/rstudio/pins-python).
+The geopins package provides geospatial support for the [Python pins package](https://github.com/rstudio/pins-python). The package publishes data, models, and other Python objects, making it easy to share them across projects and with your colleagues. With `geopins`, there is support for geospatial datatypes (e.g. `geopandas.GeoDatFrame`, and `rastr.Raster`) and filetypes (e.g. `GeoPackage`, and `GeoTIFF`), fully compatible with your existing pins boards.
+
+The pins package provides drivers for standard Python tabular datatypes (e.g. `pandas.DataFrame`) and filetypes (e.g. CSV, Parquet, etc.). The geopins package brings the same experience to geospatial datatypes (e.g. `geopandas.GeoDatFrame`, and `rastr.Raster` and filetypes, fully compatible with your existing pins boards.
 
 ## Installation
 
@@ -20,6 +20,36 @@ uv add geopins
 pip install geopins
 ```
 
+## Quick Start
+
+```python
+from pins import board_local
+
+# Patch pins to support geospatial data
+import geopins
+geopins.patch()
+
+# Define any pins board as usual
+b = board_local()
+
+# Save a GeoDataFrame
+import geopandas as gpd
+gdf = b.pin_write(
+    gpd.GeoDataFrame({"x": [1, 2, 3]}, geometry=gpd.points_from_xy([1, 2, 3], [4, 5, 6])),
+    "gdf_example",
+)
+
+# Read it back
+gdf = b.pin_read("gdf_example")
+
+# Save a raster
+from rastr.raster import Raster
+b.pin_write(Raster.example(), "raster_example")
+
+# Read it back
+raster = b.pin_read("raster_example")
+```
+
 ## Contributing
 
 See the

docs/logo.svg

@@ -29,6 +29,10 @@ classifiers = [
 ]
 dynamic = [ "urls", "version" ]
 dependencies = [
+  "geopandas>=1.1.1",
+  "pins>=0.9.1",
+  "pyarrow>=21.0.0",
+  "rastr>=0.6.0",
 ]
 
 [dependency-groups]
@@ -56,6 +60,7 @@ dev = [
 test = [
   "coverage[toml]>=7.10.1",
   "detect-test-pollution>=1.2.0",
+  "pandas>=2.3.3",
   "pytest>=8.4.1",
   "pytest-cov>=6.2.1",
   "pytest-emoji>=0.2.0",
@@ -170,16 +175,6 @@ lint.per-file-ignores."tests/**/*.py" = [
 ]
 lint.allowed-confusables = [ "ℹ", "–", "σ" ]
 lint.flake8-tidy-imports.banned-api."pytz".msg = "'zoneinfo' should be preferred to 'pytz' when using Python 3.9 and later, see https://tonkintaylor-sonarqube.azurewebsites.net/coding_rules?open=python%3AS6890&rule_key=python%3AS6890"
-lint.flake8-tidy-imports.banned-module-level-imports = [
-  "branca",
-  "folium",
-  "geopandas",
-  "matplotlib",
-  "mpl_toolkits",
-  "pandas",
-  "scipy",
-  "tqdm",
-]
 
 lint.flake8-type-checking.quote-annotations = true
 lint.flake8-type-checking.runtime-evaluated-base-classes = [ "pydantic.BaseModel" ]
@@ -193,6 +188,8 @@ ignore-words-list = [ "..." ]
 [tool.deptry]
 extend_exclude = [ "src/notebooks", "src/scripts", "src/archive" ]
 experimental_namespace_package = true
+[tool.deptry.per_rule_ignores]
+DEP002 = [ "pyarrow" ]
 
 [tool.pyproject-fmt]
 keep_full_version = true
@@ -249,7 +246,14 @@ root_packages = [ "geopins" ]
 [[tool.importlinter.contracts]]
 name = "geopins"
 type = "layers"
-layers = [  ]
+layers = [ "patch_", "boards", "drivers", "meta", "filetypes | interfaces" ]
 containers = [ "geopins" ]
 exhaustive = true
 exhaustive_ignores = [ "_version" ]
+
+[[tool.importlinter.contracts]]
+name = "geopins.drivers"
+type = "layers"
+layers = [ "gdf | raster", "exceptions | infer" ]
+containers = [ "geopins.drivers" ]
+exhaustive = true