Skip to main content

Lat/Lon to administrative hierarchy lookup with managed datasets.

Project description

cadis

cadis is the single public control layer of the Cadis system.

It orchestrates:

  • dataset install and bootstrap lifecycle
  • world resolution and runtime execution coordination
  • deterministic state to user-facing actions
  • SDK + CLI + REST integration surfaces

Install

pip install cadis

Quick Start (CLI)

cadis lookup 41.8785708032352 12.505896501941912

Typical flow:

  • If the country dataset is already installed, Cadis prints Region: ... immediately.
  • If the dataset is missing but supported, Cadis offers to download it and retries the lookup after install.
  • Sea and offshore results are shown directly in human-readable form.

Quick Start (SDK)

from cadis import CadisSDK

sdk = CadisSDK()
out = sdk.lookup(25.0330, 121.5654)
print(out["execution"]["lookup_status"])

Interaction Modes

Core APIs

  • lookup(lat, lon)
  • bootstrap(iso2, ...)
  • reinstall(iso2, ...)
  • info()
  • CadisSDK
  • CadisRemoteSDK

Dataset Lockdown

By default, Cadis serves lookups from any installed dataset in the cache folder.

To restrict serving to a subset of installed country datasets, set:

export CADIS_ALLOWED_ISO2=TW,JP

When enabled, Cadis fails lookups outside the allowlist with state.dataset.status = "blocked" and refuses bootstrap/reinstall for those countries.

Architecture

cadis (public control layer)
  -> world resolution (`cadis.world`)
  -> dataset install/provisioning (`cadis.cdn`)
  -> dataset bootstrap/lookup runtime (`cadis.runtime`)
  -> deterministic structural engine (`cadis.core`)
  -> remote REST surface (`cadisd`)

ISO Code Policy

Cadis uses ISO 3166-1 alpha-2 codes as technical identifiers.

These codes are interpreted strictly according to the ISO 3166 standard and are used solely for data partitioning and administrative dataset selection.

Cadis does not interpret ISO codes as political statements or sovereignty declarations.


Supported ISO 3166-1 Entities

ISO2 Name Dataset ID Package Size (tar.gz) Unpacked Size Release Date (UTC)
TW Taiwan tw.admin 1.8 MB 2.0 MB 2026-04-05
JP Japan jp.admin 20.4 MB 21.4 MB 2026-04-05
GB United Kingdom gb.admin 4.8 MB 5.2 MB 2026-04-05
IT Italy it.admin 22.9 MB 26.0 MB 2026-04-05
KR South Korea kr.admin 2.4 MB 3.6 MB 2026-04-05
SE Sweden se.admin 0.2 MB 0.3 MB 2026-04-05
NO Norway no.admin 0.1 MB 0.3 MB 2026-04-05
DK Denmark dk.admin 0.1 MB 0.2 MB 2026-04-05
BE Belgium be.admin 2.5 MB 2.8 MB 2026-04-04

Additional ISO 3166-1 entity datasets will be published as they become available.

License

Cadis source code is licensed under Apache License 2.0. See LICENSE.

The bundled file cadis/world/data/ne.global.v0.1.0.cgd is transformed from Natural Earth data. Natural Earth states that its raster and vector data on the site are public domain and that no permission is needed to use it. See cadis/world/data/CGD_SPEC.md and THIRD_PARTY_NOTICES.md.

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

cadis-0.4.9.tar.gz (9.0 MB view details)

Uploaded Source

Built Distribution

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

cadis-0.4.9-py3-none-any.whl (9.0 MB view details)

Uploaded Python 3

File details

Details for the file cadis-0.4.9.tar.gz.

File metadata

  • Download URL: cadis-0.4.9.tar.gz
  • Upload date:
  • Size: 9.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for cadis-0.4.9.tar.gz
Algorithm Hash digest
SHA256 9ccde1f02ff1c1151aec515701a725403768e9adc99efa342c72193fd3bf09d4
MD5 419dab75ecb04e928f2578d1aa10c1c9
BLAKE2b-256 d08df8a09e42e77dff12ab91054802439cfdcf0fb01147ed492b8ae846e7b8de

See more details on using hashes here.

File details

Details for the file cadis-0.4.9-py3-none-any.whl.

File metadata

  • Download URL: cadis-0.4.9-py3-none-any.whl
  • Upload date:
  • Size: 9.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for cadis-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 bf6e835a634aff2bc3950894caec0cfd6a2faf18bcf3651bcb0c06e49f408273
MD5 613217595043d6da0031fbecc742aa13
BLAKE2b-256 39760beaf1591bc50ad3807adf25925a2d75295d9cb69a99b267bf7d0db0a2a5

See more details on using hashes here.

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