geodetic_engine.georepository

Client for the Georepository geodetic registry API.

Implemented from the Georepository OpenAPI document so that it works against any instance, not one particular deployment.

Example

>>> from geodetic_engine.georepository import (
...     GeorepositoryClient,
...     GeorepositoryConfig,
... )
>>> config = GeorepositoryConfig(
...     api_url="https://georepository.example.com",
...     client_id="...",
...     client_secret="...",
... )
>>> with GeorepositoryClient(config) as client:
...     for datum in client.iter_collection("Datum", authorities={"Example"}):
...         print(datum["Code"], datum["Name"])

Classes

GeorepositoryClient	Reads objects from a Georepository instance.
GeorepositoryConfig	How to reach and authenticate against a Georepository instance.
GeorepositoryCredential	Fetches and caches an OAuth2 access token.

Constants and type aliases

DEFAULT_PAGE_SIZE	int([x]) -> integer int(x, base=10) -> integer
DEFAULT_SCOPE	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Exceptions

GeorepositoryApiError	The API returned an unusable response.
GeorepositoryAuthError	An OAuth2 token could not be obtained or refreshed.
GeorepositoryConfigError	The Georepository connection settings are missing or inconsistent.
GeorepositoryError	Base class for Georepository access failures.
PaginationTruncatedError	Paging did not return every advertised result.