pydeck-carto

Pydeck wrapper for use with CARTO.

Install

pip install pydeck-carto

This also ensures pydeck is installed. If you haven't previously enabled pydeck to be used with Jupyter, follow its instructions to install.

Installing from source

git clone https://github.com/visgl/deck.gl
cd deck.gl/bindings/pydeck-carto
pip install .

Usage

import pydeck as pdk
import pydeck_carto as pdkc
from carto_auth import CartoAuth

# Authentication with CARTO
carto_auth = CartoAuth.from_oauth()

# Register new layer types in pydeck
pdkc.register_layers()

# Create CARTO data source
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",
)

# Render CARTO layer in pydeck
layer = pdk.Layer(
    "VectorTileLayer",
    data=data,
    get_fill_color=[238, 77, 90],
    point_radius_min_pixels=2.5,
    pickable=True,
)
view_state = pdk.ViewState(latitude=0, longitude=0, zoom=1)
pdk.Deck(layer, map_style=pdk.map_styles.ROAD, initial_view_state=view_state)

For more information, check the examples section and the documentation.

Development

Make commands:

init: create the environment and install dependencies
lint: run linter (black + flake8)
test: run tests (pytest)
publish-pypi: publish package in pypi.org
publish-test-pypi: publish package in test.pypi.org
clean: remove the environment

Contributors

Dependencies of pydeck-carto (3).
Dependency	Optional
carto-auth	false
pydeck	false
typing-extensions	false

Package profile

pydeck-carto

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description