Skip to main content

A python client for accessing and querying geospatial open data portals.

Project description

kapipy

A python client for accessing and querying datasets from geospatial open data portals such as LINZ, Stats NZ and LRIS.

Overview

kapipy is a Python package that provides a python interface to the Koordinates geospatial content management system. It allows users to connect to a data portal, retrieve metadata, and query vector layers and tables.

Installation

pip install kapipy

Basic Usage

  • Import kapipy.
  • Create a GIS object, passing in an api key.
  • Get a reference to an item using {gis}.content.get({layer_id})
  • Perform actions on the item.

Basic example:

from kapipy.gis import GIS
linz = GIS(name="linz", api_key="my-linz-api-key")
rail_station_layer_id = "50318"
itm = linz.content.get(rail_station_layer_id)
data = itm.query()
data.head()

Disclaimer

This is a hobby project and the modules are provided as-is on a best-effort basis.
The author has no affiliation with either Koordinates nor LINZ, Stats NZ or LRIS. As such, the underlying API's and services may change at any time without warning and break these modules.

This project does not cover the full spectrum of the Koordinates API and probably never will. It focuses currently on basic workflows such as connecting using an api key, getting references to datasets and downloading them.

Suggestions and code contributions can be made by submitting issues via the GitHub page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kapipy-0.1.9.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kapipy-0.1.9-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file kapipy-0.1.9.tar.gz.

File metadata

  • Download URL: kapipy-0.1.9.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kapipy-0.1.9.tar.gz
Algorithm Hash digest
SHA256 256b1716036890b5b0239d1acae40cc4af84149ea78c74bebe79638cba7f531d
MD5 cbb0f59f0259ba9e60124d3b361953fa
BLAKE2b-256 b02bea74ce6e5b3019cf36b8c59eeedb6a2275869e69260eb7527ac9d8edb831

See more details on using hashes here.

Provenance

The following attestation bundles were made for kapipy-0.1.9.tar.gz:

Publisher: python-publish.yml on phaakma/kapipy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kapipy-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: kapipy-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kapipy-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 61577ba9f3f5a915a9c94c7996399dfcbc212346e438a8ed94897cad5808e8ff
MD5 f46b496df4e3f81c568e84825506f587
BLAKE2b-256 d243a86e0f9ca9e9cd3c63c14838cc4b6793468e0775ccde0f533a1589e4a282

See more details on using hashes here.

Provenance

The following attestation bundles were made for kapipy-0.1.9-py3-none-any.whl:

Publisher: python-publish.yml on phaakma/kapipy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page