feat(pydeck): Support Deck v9 in bindings (#8577)

* feat(pydeck): Update to Deck v9 * feat(pydeck-carto): Add new CARTO layers, sources, and auth flow (#8791, #8806) --------- Co-authored-by: Don McCurdy <donmccurdy@cartodb.com>
visgl · Apr 26, 2024 · 9be0e4a · 9be0e4a
1 parent 3773e9f
commit 9be0e4a
Show file tree

Hide file tree

Showing 31 changed files with 707 additions and 232 deletions.
diff --git a/bindings/pydeck-carto/Makefile b/bindings/pydeck-carto/Makefile
@@ -16,6 +16,9 @@ lint:
 test:
 	$(BIN)/pytest tests --cov=pydeck_carto
 
+test-scripts:
+	for file in examples/scripts/*.py; do $(BIN)/python "$$file"; done
+
 publish-pypi:
 	rm -rf $(DIST) $(BUILD) *.egg-info
 	$(BIN)/python setup.py sdist bdist_wheel

diff --git a/bindings/pydeck-carto/README.md b/bindings/pydeck-carto/README.md
@@ -31,16 +31,19 @@ from carto_auth import CartoAuth
 # Authentication with CARTO
 carto_auth = CartoAuth.from_oauth()
 
-# Register CartoLayer in pydeck
-pdkc.register_carto_layer()
-
-# Render CartoLayer in pydeck
+# Register new layer types in pydeck
+pdkc.register_layers()
+
+# Render CARTO layer in pydeck
+data = pdkc.sources.vector_query_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    sql_query="SELECT geom, name FROM carto-demo-data.demo_tables.world_airports",
+)
 layer = pdk.Layer(
-    "CartoLayer",
-    data="SELECT geom, name FROM carto-demo-data.demo_tables.airports",
-    type_=pdkc.MapType.QUERY,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
+    "VectorTileLayer",
+    data=data,
     get_fill_color=[238, 77, 90],
     point_radius_min_pixels=2.5,
     pickable=True,

diff --git a/bindings/pydeck-carto/docs/changelog.rst b/bindings/pydeck-carto/docs/changelog.rst
@@ -3,9 +3,23 @@ CHANGELOG
 
 Releases and associated GitHub PRs for pydeck-carto are documented here.
 
+0.2 Releases
+------------
+
+0.2.0b0 - Apr 24 2024
+^^^^^^^^^^^^^^^^^^^
+- Update to deck.gl v9.0
+- Rename register_carto_layer to register_layers
+- Add layer enums: VectorTileLayer, H3TileLayer, QuadbinTileLayer
+- Add source functions: vector_table_source, vector_query_source, vector_tileset_source, h3_table_source, h3_query_source, h3_tileset_source, quadbin_table_source, quadbin_query_source, quadbin_tileset_source
+
 0.1 Releases
 ------------
 
+0.1.1b0 - Apr 24 2024
+^^^^^^^^^^^^^^^^^^^
+- Update to deck.gl v8.9
+
 0.1.0 - Nov 04 2022
 ^^^^^^^^^^^^^^^^^^^
 - Add register_carto_layer function: integration with pydeck (CartoLayer).

diff --git a/bindings/pydeck-carto/docs/conf.py b/bindings/pydeck-carto/docs/conf.py
@@ -12,9 +12,9 @@
 copyright = f"{datetime.datetime.utcnow().year}, CartoDB Inc"
 author = "CARTO"
 # The short X.Y version
-version = "0.1"
+version = "0.2"
 # The full version, including alpha/beta/rc tags
-release = "0.1.0"
+release = "0.2.0b0"
 # Extensions to generate documents from our docstrings here
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme"]
 templates_path = ["_templates"]

diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_geo_query.py b/bindings/pydeck-carto/examples/scripts/carto_layer_geo_query.py
@@ -7,17 +7,22 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
+
+data = pdkc.sources.vector_query_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    sql_query="SELECT geom, name FROM carto-demo-data.demo_tables.world_airports",
+)
 
 layer = pdk.Layer(
-    "CartoLayer",
-    data="SELECT geom, name FROM carto-demo-data.demo_tables.airports",
-    type_=pdkc.MapType.QUERY,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
+    "VectorTileLayer",
+    data=data,
     get_fill_color=[238, 77, 90],
     point_radius_min_pixels=2.5,
     pickable=True,
@@ -26,4 +31,4 @@
 view_state = pdk.ViewState(latitude=0, longitude=0, zoom=1)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_geo_query.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_geo_query.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_geo_query_param.py b/bindings/pydeck-carto/examples/scripts/carto_layer_geo_query_param.py
@@ -7,19 +7,24 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
 
-layer = pdk.Layer(
-    "CartoLayer",
-    data="SELECT geom, event FROM carto-demo-data.demo_tables"
+data = pdkc.sources.vector_query_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    sql_query="SELECT geom, event FROM carto-demo-data.demo_tables"
     ".spain_earthquakes where depth > ?",
     query_parameters=[2],
-    type_=pdkc.MapType.QUERY,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
+)
+
+layer = pdk.Layer(
+    "VectorTileLayer",
+    data=data,
     get_fill_color=[238, 77, 90],
     point_radius_min_pixels=2.5,
     pickable=True,
@@ -28,4 +33,4 @@
 view_state = pdk.ViewState(latitude=36, longitude=-7.44, zoom=5)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_geo_query_param.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_geo_query_param.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_geo_table.py b/bindings/pydeck-carto/examples/scripts/carto_layer_geo_table.py
@@ -7,17 +7,22 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
+
+data = pdkc.sources.vector_table_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    table_name="carto-demo-data.demo_tables.world_airports",
+)
 
 layer = pdk.Layer(
-    "CartoLayer",
-    data="carto-demo-data.demo_tables.airports",
-    type_=pdkc.MapType.TABLE,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
+    "VectorTileLayer",
+    data=data,
     get_fill_color=[200, 0, 80],
     point_radius_min_pixels=2,
     pickable=True,
@@ -26,4 +31,4 @@
 view_state = pdk.ViewState(latitude=0, longitude=0, zoom=1)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_geo_table.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_geo_table.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_geo_tileset.py b/bindings/pydeck-carto/examples/scripts/carto_layer_geo_tileset.py
@@ -7,17 +7,22 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
+
+data = pdkc.sources.vector_tileset_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    table_name="carto-demo-data.demo_tilesets.pointsofinterest_esp",
+)
 
 layer = pdk.Layer(
-    "CartoLayer",
-    data="carto-demo-data.demo_tilesets.pointsofinterest_esp",
-    type_=pdkc.MapType.TILESET,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
+    "VectorTileLayer",
+    data=data,
     get_fill_color=[200, 0, 80],
     stroked=False,
     point_radius_min_pixels=2,
@@ -27,4 +32,4 @@
 view_state = pdk.ViewState(latitude=36, longitude=-7.44, zoom=5)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_geo_tileset.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_geo_tileset.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_h3_query.py b/bindings/pydeck-carto/examples/scripts/carto_layer_h3_query.py
@@ -7,24 +7,29 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
 
-layer = pdk.Layer(
-    "CartoLayer",
-    data="select * from carto-demo-data.demo_tables"
+data = pdkc.sources.h3_query_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    sql_query="select * from carto-demo-data.demo_tables"
     ".derived_spatialfeatures_usa_h3res8_v1_yearly_v2",
-    type_=pdkc.MapType.QUERY,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
-    geo_column=pdkc.GeoColumnType.H3,
+    aggregation_exp="sum(population) as population_sum",
+)
+
+layer = pdk.Layer(
+    "H3TileLayer",
+    data=data,
     get_fill_color=[200, 0, 80],
     pickable=True,
 )
 
 view_state = pdk.ViewState(latitude=44, longitude=-122, zoom=3)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_h3_query.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_h3_query.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_h3_table.py b/bindings/pydeck-carto/examples/scripts/carto_layer_h3_table.py
@@ -7,23 +7,29 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
+
+data = pdkc.sources.h3_table_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    table_name="carto-demo-data.demo_tables"
+    ".derived_spatialfeatures_esp_h3res8_v1_yearly_v2",
+    aggregation_exp="sum(population) as population_sum",
+)
 
 layer = pdk.Layer(
-    "CartoLayer",
-    data="carto-demo-data.demo_tables.derived_spatialfeatures_esp_h3res8_v1_yearly_v2",
-    type_=pdkc.MapType.TABLE,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
-    geo_column=pdkc.GeoColumnType.H3,
+    "H3TileLayer",
+    data=data,
     get_fill_color=[200, 0, 80],
     pickable=True,
 )
 
 view_state = pdk.ViewState(latitude=36, longitude=-7.44, zoom=5)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_h3_table.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_h3_table.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_h3_tileset.py b/bindings/pydeck-carto/examples/scripts/carto_layer_h3_tileset.py
@@ -7,23 +7,29 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
 
-layer = pdk.Layer(
-    "CartoLayer",
-    data="carto-demo-data.demo_tilesets"
+data = pdkc.sources.h3_tileset_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    table_name="carto-demo-data.demo_tilesets"
     ".derived_spatialfeatures_usa_h3res8_v1_yearly_v2_tileset",
-    type_=pdkc.MapType.TILESET,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
+    aggregation_exp="sum(population) as population_sum",
+)
+
+layer = pdk.Layer(
+    "H3TileLayer",
+    data=data,
     get_fill_color=[200, 0, 80],
     pickable=True,
 )
 
 view_state = pdk.ViewState(latitude=44, longitude=-122, zoom=3)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_h3_tileset.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_h3_tileset.html"))
diff --git a/bindings/pydeck-carto/examples/scripts/carto_layer_quadbin_query.py b/bindings/pydeck-carto/examples/scripts/carto_layer_quadbin_query.py
@@ -7,24 +7,29 @@
 import pydeck as pdk
 import pydeck_carto as pdkc
 from carto_auth import CartoAuth
+from os.path import join, dirname
 
 carto_auth = CartoAuth.from_oauth()
 
-pdkc.register_carto_layer()
+pdkc.register_layers()
 
-layer = pdk.Layer(
-    "CartoLayer",
-    data="select * from carto-demo-data.demo_tables"
+data = pdkc.sources.quadbin_query_source(
+    access_token=carto_auth.get_access_token(),
+    api_base_url=carto_auth.get_api_base_url(),
+    connection_name="carto_dw",
+    sql_query="select * from carto-demo-data.demo_tables"
     ".derived_spatialfeatures_usa_quadbin15_v1_yearly_v2",
-    type_=pdkc.MapType.QUERY,
-    connection=pdkc.CartoConnection.CARTO_DW,
-    credentials=pdkc.get_layer_credentials(carto_auth),
-    geo_column=pdkc.GeoColumnType.QUADBIN,
+    aggregation_exp="sum(population) as population_sum",
+)
+
+layer = pdk.Layer(
+    "QuadbinTileLayer",
+    data=data,
     get_fill_color=[200, 0, 80],
     pickable=True,
 )
 
 view_state = pdk.ViewState(latitude=44, longitude=-122, zoom=3)
 
 r = pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)
-r.to_html("carto_layer_quadbin_query.html", open_browser=True)
+r.to_html(join(dirname(__file__), "carto_layer_quadbin_query.html"))