Skip to content

to_geojson

to_geojson

to_geojson(df: DataFrame, *, path: str | None = None, lat: str = 'lat', lon: str = 'lon') -> str | None

Export stations / zones to GeoJSON for QGIS, kepler.gl, etc. (data, not a map).

Accepts a plain lat/lon frame (promoted to points) or a GeoDataFrame (any geometry, e.g. geofencing polygons). Returns the GeoJSON string, or writes it to path and returns the path. Requires the optional [geo] extra.

See Also

to_gdf : Build a GeoDataFrame instead.

Source code in src/gbfs_toolkit/spatial/geometry.py
def to_geojson(
    df: pd.DataFrame,
    *,
    path: str | None = None,
    lat: str = "lat",
    lon: str = "lon",
) -> str | None:
    """Export stations / zones to GeoJSON for QGIS, kepler.gl, etc. (data, not a map).

    Accepts a plain lat/lon frame (promoted to points) or a ``GeoDataFrame`` (any geometry,
    e.g. geofencing polygons). Returns the GeoJSON string, or writes it to ``path`` and returns
    the path. Requires the optional ``[geo]`` extra.

    See Also
    --------
    [`to_gdf`][gbfs_toolkit.to_gdf] : Build a GeoDataFrame instead.
    """
    gdf = df if hasattr(df, "geometry") else to_gdf(df, lat=lat, lon=lon)
    text = gdf.to_json()
    if path is None:
        return text
    from pathlib import Path

    Path(path).write_text(text, encoding="utf-8")
    return path