Placekey-py
A Python library for working with Placekeys. Documentation for this package can be found here, and documentation for the Placekey service API can be found here.
Usage
The basic functionality of the Placekey library is conversion between Placekeys and latitude-longitude coordinates.
>>> import placekey as pk
>>> lat, long = 0.0, 0.0
>>> pk.geo_to_placekey(lat, long)
'@dvt-smp-tvz'
>>> pk.placekey_to_geo('@dvt-smp-tvz')
(0.00018033323813810344, -0.00018985758738881587)
The library also allows for conversion between Placekeys and H3 indices.
>>> pk.placekey_to_h3('@dvt-smp-tvz')
'8a754e64992ffff'
>>> pk.h3_to_placekey('8a754e64992ffff')
'@dvt-smp-tvz'
The distance in meters between two Placekeys can be found with the following function.
>>> pk.placekey_distance('@dvt-smp-tvz', '@5vg-7gq-tjv')
12795124.895573696
An upper bound on the maximal distance in meters between two Placekeys based on the length of their shared prefix is provided by placekey.get_prefix_distance_dict().
>>> pk.get_prefix_distance_dict()
{0: 20040000.0,
1: 20040000.0,
2: 2777000.0,
3: 1065000.0,
4: 152400.0,
5: 21770.0,
6: 8227.0,
7: 1176.0,
8: 444.3,
9: 63.47}
Placekeys found in a data set can be partially validated by
>>> pk.placekey_format_is_valid('222-227@dvt-smp-tvz')
True
>>> pk.placekey_format_is_valid('@123-456-789')
False
Notebooks
Jupyter notebooks demonstrating various Placekey functionality are contained in the placekey-notebooks repository.
Support
This package runs on Python 3.
3 maintainers
Release files for placekey 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| placekey-0.0.4.tar.gz | 5.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| placekey-0.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.7 kB
Release files / placekey-0.0.4.tar.gz
| Download URL | placekey-0.0.4.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d69a20d92fe6da660abc135c96248ff81aaa404d0fdc6394971b6669aca9068
|
|
BLAKE2b-256 checksum How to use checksums |
bb088856ae13de09a9d2be47411628adc7b18b88b9f53df2cf965464c6bec8d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3
|
Release files / placekey-0.0.4-py3-none-any.whl
| Download URL | placekey-0.0.4-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c05aa44b521a9a3ba9f4e9b3126c6fd9676154d912cb73822f1ba38dcd5241bc
|
|
BLAKE2b-256 checksum How to use checksums |
4129deb0504e1b5189084933341cce094fe92d569c5c9b641ae4e905e19ed13f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3
|
