yoro 0.1.0

Yoro — Geographic addressing via Hilbert curves (GPS ↔ compact codes). 'Yoro' means 'place' in Manding.

Yoro

Geographic addressing via Hilbert curves — GPS ↔ compact alphanumeric codes.

"Yoro" means "place" in Manding (West Africa).

Install

pip install yoro              # core only
pip install yoro[django]      # Django/GeoDjango integration
pip install yoro[fastapi]     # FastAPI server
pip install yoro[all]         # everything

Quick start

import yoro

code = yoro.encode(6.8, -5.3, domain="CI")   # "CI-..."
result = yoro.decode(code)                     # {"lat", "lon", "bounds", ...}
nbrs = yoro.neighbors(code)                    # 8 adjacent cells

Django integration

# settings.py
INSTALLED_APPS = [..., "yoro.django"]

# urls.py
urlpatterns = [
    path("api/v1/yoro/", include("yoro.django.urls")),
]

FastAPI server

yoro serve --port 8000
# or
python -m yoro.fastapi

CLI

yoro encode 6.8 -5.3 --domain CI
yoro decode CI-4H7A3B

License

MIT — Paul Guindo / Altius Academy SNC.