Skip to main content

Yoro

Documentation | PyPI | GitHub

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.

Download files

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

Source Distribution

yoro-0.3.1.tar.gz (55.1 kB view details)

Uploaded Source

Built Distribution

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

yoro-0.3.1-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file yoro-0.3.1.tar.gz.

File metadata

  • Download URL: yoro-0.3.1.tar.gz
  • Upload date:
  • Size: 55.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for yoro-0.3.1.tar.gz
Algorithm Hash digest
SHA256 4cd52243a660b8663b7c29fa29b1a38a44896951af842c1880c9c31dd1dc94e6
MD5 99d1b0a7d93eac62f9b739747f9ea8af
BLAKE2b-256 38f7b7dca04f338dcaf31dcadeac171ea5c60ea890ae1bea115c186b44a04504

See more details on using hashes here.

File details

Details for the file yoro-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: yoro-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for yoro-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e24fbdd15c5ff56fd31bc98bb00f3187d3e301fc1049c2d85035521c5d6024eb
MD5 86497d720baf3d4e20774aecdd7921b2
BLAKE2b-256 dc2bb809d5970a6b033f0ad55012e8c29d64aaf8544ebcc1fff69109e64fa30f

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 Sentry Error logging StatusPage Status page