Skip to content

Commit 6f91b46

Browse files
nyxst4ckgiswqs
andauthored
docs: quote pip extras install examples (#1473)
* docs: quote pip extras install examples * docs: quote pip extras in remaining install hints The sidecar's ML error messages and the Python README told users to run pip install with an unquoted extras spec, which zsh globs before pip sees it. Quote them the way the rest of the docs already do. --------- Co-authored-by: nyxst4ck <289980115+nyxst4ck@users.noreply.github.com> Co-authored-by: giswqs <giswqs@gmail.com>
1 parent 797b55b commit 6f91b46

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

backend/geolibre_server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ The **Apache Sedona** engine of the SQL Workspace runs Sedona spatial SQL on
9191
through the `/sql` endpoints. It is an optional extra:
9292

9393
```bash
94-
pip install -e ".[sedona]" # apache-sedona[db] + geopandas + shapely
94+
pip install -e ".[sedona]" # 'apache-sedona[db]' + geopandas + shapely
9595
geolibre-server
9696
```
9797

backend/geolibre_server/geolibre_server/app/ml.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def _require_httpx():
8585
import httpx # noqa: PLC0415
8686
except ImportError as exc: # pragma: no cover - exercised via status path
8787
raise RuntimeBootstrapError(
88-
"The 'ml' extra is not installed. Install with: pip install geolibre-server[ml]"
88+
"The 'ml' extra is not installed. Install with: pip install \"geolibre-server[ml]\""
8989
) from exc
9090
return httpx
9191

@@ -186,7 +186,7 @@ def _ensure_server() -> str:
186186
if command is None:
187187
raise RuntimeBootstrapError(
188188
"samgeo-api was not found on PATH. Install the segmentation "
189-
"stack with: pip install segment-geospatial[api,samgeo3], or set "
189+
'stack with: pip install "segment-geospatial[api,samgeo3]", or set '
190190
"GEOLIBRE_ML_SAMGEO_URL to an existing samgeo-api server."
191191
)
192192

@@ -332,7 +332,7 @@ def ml_status():
332332

333333
payload["message"] = (
334334
"Segmentation backend is unavailable. Install it with: "
335-
"pip install segment-geospatial[api,samgeo3], or set "
335+
'pip install "segment-geospatial[api,samgeo3]", or set '
336336
"GEOLIBRE_ML_SAMGEO_URL to an existing samgeo-api server."
337337
)
338338
return payload

python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ m.to_project()["mapView"]["center"]
102102
(works in the running server with no restart where it is installed). On other
103103
remote servers (Binder, remote JupyterLab), pass `Map(server_proxy=True)` to
104104
use that same remote path; `Map(server_proxy=False)` forces the direct path.
105-
- Optional extras: `pip install geolibre[all]` adds GeoPandas/Shapely support
105+
- Optional extras: `pip install "geolibre[all]"` adds GeoPandas/Shapely support
106106
for `add_geojson(geodataframe)` and for reading **local** vector files
107107
(`add_vector`/`add_geoparquet`/`add_flatgeobuf`/`add_shp`/`add_kml`/`add_gpkg`),
108108
which the kernel reads and inlines as GeoJSON. Remote URLs for the same formats stream through

0 commit comments

Comments
 (0)