Skip to main content

Converts postcodes to timezones

Project description

Postcode to Timezone

Looks up timezones based on postcode. This is based on the assumption that postcodes are roughly following the timezone lines. This is not always true, especially in disputed territories, but it is a good approximation for most cases.

The data used for this lookup is indirectly from OpenStreetMap.

Usage example

from postcode_to_timezone import get_tz

get_tz('us', '12345')

returns 'America/Chicago'

Building

To regenerate the lookup table, first obtain a dump of the location_postcode table from a Nominatim database, and compress it to location_postcode.csv.xz. Then run python3 generate_lookup_table.py to generate the lookup table.

Actual package is built with hatch build, and the package is uploaded to PyPI with hatch publish.

Data sources

Postcode locations

A dump of the location_postcode table in a Nominatim database. Nominatim creates this database from OpenStreetMap data using the following query:

SELECT
    COALESCE(plx.country_code, get_country_code(ST_Centroid(pl.geometry))) as country_code,
    pl.address->'postcode' as postcode,
    COALESCE(plx.centroid, ST_Centroid(pl.geometry)) as geometry
  FROM place AS pl
  LEFT OUTER JOIN placex AS plx
         ON pl.osm_id = plx.osm_id AND pl.osm_type = plx.osm_type
WHERE
 pl.address ? 'postcode'
 AND pl.geometry IS NOT null

A dump from that table is stored at location_postcode.csv.xz.

Postcode validation

A copy from this GitHub Gist is stored in postcode_regex.json. Actual source not known.

Timezone definitions

Timezone definitions are used from timezonefinder package on pypi. The package is licensed under the MIT license.

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

postcode_to_timezone-2024.11.27.2.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

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

postcode_to_timezone-2024.11.27.2-py2.py3-none-any.whl (15.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file postcode_to_timezone-2024.11.27.2.tar.gz.

File metadata

File hashes

Hashes for postcode_to_timezone-2024.11.27.2.tar.gz
Algorithm Hash digest
SHA256 b938a7d80885917cd9cd322ef6573724609bbcf22828ee2aefe7c6341ee536ee
MD5 04dbe56402675bacc26016cabf0187b8
BLAKE2b-256 e86015aa0ac6285dfd8b0d00950f14ed8b0fa29b6352f28e366c86d2680b88e7

See more details on using hashes here.

File details

Details for the file postcode_to_timezone-2024.11.27.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for postcode_to_timezone-2024.11.27.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 719c211e8c7e0a2a1d36fbc11947ad06c955c3a1c2a54ea0c2d88a6695755205
MD5 57859e722cea3409ee26c1f0a61f0ef6
BLAKE2b-256 d10f28bfe33234de30b7b73cf5539a6464c0b1abef7b884b20d5d425c1c585ff

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