Référence de l’API
Téléchargement
Point d’entrée du client, exporté par cartiflette.
| carti_download | Download official French borders produced by cartiflette. |
Chemins et formats
Construction des chemins S3 (contrat partagé avec le pipeline, cartiflette/paths.py) et normalisation des paramètres.
| utils.create_path_bucket | Path of a cartiflette file within the S3 storage. |
| utils.create_path_consolidated | Path of a consolidated GeoParquet file within the S3 storage. |
| utils.standardize_format | Format of the stored files matching a user-facing format name. |
| utils.value_candidates | Values to try, in order, in the path of a file. |
Fonctions internes
Choix du format, lecture avec DuckDB (liste de liens GeoJSON, GeoParquet filtré en SQL) et conversion finale en GeoDataFrame.
| client.choose_format | Format of the files to read. |
| client.connect | DuckDB connection able to read the cartiflette files. |
| client.consolidated_url | Link of the consolidated GeoParquet holding the polygons for filter_by. |
| client.parquet_available | Whether a consolidated GeoParquet exists for these parameters. |
| client.geojson_available | Whether GeoJSON files exist for these parameters. |
| client.geojson_urls | Links of the GeoJSON files of some values, one file per value. |
| client.read_geojson | Relation over several GeoJSON files, one row per feature. |
| client.read_parquet | Relation over the polygons of some values in a consolidated GeoParquet. |
| client.to_geopandas | Convert a relation with a geometry column into a GeoDataFrame. |