Skip to content

Honua Python SDK

Two installable packages provide Python access to the Honua platform:

Package PyPI name Description
honua-sdk honua-sdk Data-plane client -- feature queries, geocoding, gRPC streaming, GeoPandas integration
honua-admin honua-admin Control-plane client -- services, connections, layers, styles, metadata, manifests

Requires Python 3.11+.

The canonical idiom

from honua_sdk import HonuaClient, Query, SourceDescriptor, SourceLocator

with HonuaClient("https://your-honua-server.com") as client:
    source = client.source(
        SourceDescriptor(
            id="test_service",
            protocol="geoservices-feature-service",
            locator=SourceLocator(service_id="test_service", layer_id=0),
        )
    )
    result = source.query(Query(where="status = 'active'", out_fields=["*"]))
    for feature in result.features[:3]:
        print(feature.id, feature.properties)

The same shape -- client.source(descriptor).query(Query(...)) -- works across FeatureServer, OGC API Features, STAC, OData, and WFS protocols.

Install

# Data / protocol client
pip install honua-sdk

# With gRPC support
pip install honua-sdk[grpc]

# With GeoPandas integration
pip install honua-sdk[geopandas]

# Admin / control-plane client (depends on honua-sdk)
pip install honua-admin

I want to...

Goal Start here
Query features in 5 minutes Quickstart
Stream features over gRPC Core client
Wire a FastAPI service Examples
Manage services & connections honua-admin reference
Understand the protocol matrix Protocol parity
Diagnose an error Troubleshooting

Where to next

  • Quickstart -- 5-minute setup and first query.
  • Core client guide -- the Source / Query / Result facade and capability checks.
  • API Reference -- autogenerated docs for every public class in honua-sdk and honua-admin.
  • Examples -- runnable demos (ETL, FastAPI, data quality reporting).
  • Authentication -- bearer tokens, API keys, refreshable auth.
  • Compatibility -- server compatibility baseline and release gating policy.